QA checks and validation for migrating existing documentation sites to new platforms.
This repo contains all the checks, checklists, and tooling needed to ensure quality when migrating an existing docs site to a new docs platform.
specs/ # QA spec definitions
getting-url-mapping.md # URL mapping between old ↔ new site
...
specs/tests/ # Tests for each spec
getting-url-mapping.test.md
...
testing/ # Testing framework
TESTING.md # Rules for writing & running spec tests
runs/ # Test run outputs (gitignored)
examples/
Marqeta/ # Real client example data (Marqeta)
ai-created/ # Synthetic example data
| Spec | Description | Test |
|---|---|---|
| Getting URL Mapping | Verify every page on existing site maps to new site | Test |
See testing/TESTING.md for the rules on writing and running spec tests.
TL;DR:
- Every spec needs tests.
- Every test needs: example data, a list of checks, and an example output.
- Run tests by executing the spec with test data, then evaluate output against checks.
🚧 Under construction — being populated with migration QA processes.