documentation

Apply frontmatter to markdown documentation pages to define the page name and description. This frontmatter-driven approach enables predictable SEO metadata, structured navigation, and consistent rendering when using Astro Starlight.

Organize a docs directory by categorizing markdown files into Tutorials, How-to Guides, Reference, and Explanation sections. Enforce a frontmatter block with name and description on each page to maintain standardized formatting for Astro Starlight rendering.

Yes, you need markdown frontmatter for every documentation page. The system enforces a frontmatter block containing a name and description for each file to ensure consistent metadata, SEO optimization, and predictable page rendering.

Yes, Astro Starlight supports GitHub-flavored Markdown for project documentation. The system provides standardized style guidelines for formatting and navigation to ensure readability and consistency across all rendered documentation pages.

You should not use the Diátaxis framework for documentation if your project does not require structured tutorials, how-to guides, reference materials, or explanations. It is designed for software projects needing predictable rendering and consistent content categorization.