Testing & QA

Maintaining high quality documentation requires regular testing and verification.

Build Testing

The most important test is running the production build. This process validates:

• Content: Checks frontmatter types and schema validation.
• Links: Verifies that all internal links resolve correctly.
• Code: Checks for syntax errors and build failures.

To run the build test:

pnpm build

Tip

We rely on pnpm build as our primary validation gate. If the build passes, the site is generally ready for deployment.

Type Checking

We use Astro’s strict type checking to ensure code stability.

pnpm check

This runs astro check, which analyzes your project for TypeScript errors inside .astro and .mdx files.

Manual Verification

While automated tests catch many errors, manual verification is essential for user experience.

1. Preview the Build: Run pnpm preview to verify the final output locally.

2. Check Navigation: Click through the sidebar and navigation links to ensure the structure makes sense.

3. Responsive Check: View the docs on different viewport sizes (mobile, tablet, desktop) to ensure readability.

4. Dark/Light Mode: Toggle the theme to ensure text and components are legible in both modes.

Accessibility

We are committed to making our documentation accessible.

• Semantic HTML: Use correct heading levels (##, ###).
• Alt Text: Always include descriptive alt text for images.
• Keyboard Navigation: Ensure custom components are focusable and interactive.