Organize project documentation into Diátaxis-structured pages with Astro Starlight.
npx skills add https://github.com/github/gh-aw --skill documentation-github
Please help me install this Agent Skill. Skill: documentation Source: https://github.com/github/gh-aw/tree/main/skills/documentation Command: npx skills add https://github.com/github/gh-aw --skill documentation-github
The documentation for a project can be hard to discover, inconsistent, and difficult to maintain. This Skill helps you structure, standardize, and publish documentation using the Diátaxis framework.
Start by outlining your documentation goals, then create a docs/ directory following the four Diátaxis types and the required frontmatter conventions. Then build your first example page and render it with Astro Starlight.
High-intent search queries and answers about installing and using this skill.
The Diátaxis framework structures project documentation into four distinct types: tutorials, how-to guides, reference material, and explanations. This separation ensures content is organized by user intent, improving overall discoverability and maintainability.
Organize project documentation by creating a docs directory and categorizing content into the four Diátaxis types. Enforce standardized frontmatter conventions and use Astro Starlight rendering to ensure pages remain consistent and SEO-friendly.
Yes, Astro Starlight supports frontmatter-based pages to render fast and searchable documentation. Combining standardized frontmatter with Astro Starlight ensures your project documentation remains SEO-friendly and consistently styled.
To scale documentation governance for larger software projects, enforce consistent style and standardized templates across all pages. Applying the Diátaxis framework ensures content types remain organized and maintainable as the project grows.
Yes, this approach explicitly supports organizing both tutorials and reference material simultaneously. By separating these content types into distinct Diátaxis categories, users can navigate learning materials and technical specifications without confusion.
cybersaderBuild and configure the Crosswalker documentation site using Astro Starlight.
brainbrewlabsPublishes documentation to GitHub Pages, Vercel, or Netlify from source docs and build outputs.
ddttomCreate, edit, and lint Markdown files with YAML frontmatter awareness.
pleaseaiRenders Markdown into static documentation sites with Vue-powered theming.
