Organizes project documentation into Diátaxis categories using Markdown and Astro Starlight.
npx skills add https://github.com/az9713/gh-aw --skill documentation-az9713
Please help me install this Agent Skill. Skill: documentation Source: https://github.com/az9713/gh-aw/tree/main/.github/skills/documentation Command: npx skills add https://github.com/az9713/gh-aw --skill documentation-az9713
The documentation for this project is organized and rendered using a Diátaxis-driven approach, with GitHub-flavored Markdown and Astro Starlight to ensure consistency and accessibility.
Documentation must be organized into four distinct types, each serving a specific purpose: Tutorials (Learning-Oriented), How-to Guides (Goal-Oriented), Reference (Information-Oriented), and Explanation (Understanding-Oriented). The framework guides content structure, consistency, and tone, ensuring predictable navigation and learning paths for readers.
Create a starter documentation page that demonstrates a Tutorial guiding a beginner through adding content to docs/ using the Diátaxis framework.
High-intent search queries and answers about installing and using this skill.
Diátaxis is a documentation framework that organizes content into Tutorials, How-to Guides, Reference, and Explanations. It guides structure, consistency, and tone to ensure predictable navigation and learning paths for readers.
You organize markdown documentation by separating content into Tutorials, How-to Guides, Reference, and Explanations. Create a starter page in the docs/ directory to guide beginners through adding content using this structured, navigable layout.
Yes, Astro Starlight works with Diátaxis-driven GitHub-flavored Markdown to render structured documentation. This combination ensures consistency and accessibility while enforcing a Diátaxis-driven content layout across your project.
The best way is applying the Diátaxis framework, which separates Tutorials as learning-oriented content from Reference entries as information-oriented content. This distinct categorization ensures each documentation type serves its specific purpose without overlap.
Yes, you can apply this Diátaxis documentation structure to existing software projects needing consistent documentation. It organizes content across Tutorials, How-to Guides, Reference, and Explanations, enabling writers to publish with a unified structure and tone.
kaushal-waygoodOrganize project documentation into structured Diátaxis sections with frontmatter metadata.
cybersaderBuild and configure the Crosswalker documentation site using Astro Starlight.
tamago0224Convert Markdown documents to HTML for rendering or publishing.
zzafergokConvert Markdown documents to HTML using marked.js, pandoc, gomarkdown, or static site generators.
