documentation

Featured

Write concise Diataxis docs for gh-aw with Starlight markdown conventions.

Data & Documents 5,125 stars 539 forks Updated today MIT

Install

View on GitHub

Quality Score: 90/100

Stars 20%
100
Recency 20%
100
Frontmatter 20%
70
Documentation 15%
100
Issue Health 10%
50
License 10%
100
Description 5%
100

Skill Content

### Documentation Documentation lives in `docs/`, uses GitHub-flavored Markdown, renders with Astro Starlight, and follows Diátaxis. ## Diátaxis Framework Organize documentation into four Diátaxis types: ### 1. Tutorials (Learning-Oriented) **Purpose**: Guide beginners through achieving a specific outcome to build confidence. - Start with what the user will build or achieve - Provide a clear, step-by-step path from start to finish - Include concrete examples and working code - Assume minimal prior knowledge - Focus on the happy path (avoid edge cases and alternatives) - End with a working result the user can see and use - Use imperative mood: "Create a file", "Run the command" **Avoid**: Explaining concepts in depth, multiple options, troubleshooting ### 2. How-to Guides (Goal-Oriented) **Purpose**: Show how to solve a specific real-world problem or accomplish a particular task. - Title format: "How to [accomplish specific goal]" - Assume the user knows the basics - Focus on practical steps to solve one problem - Include necessary context but stay focused - Show multiple approaches only when genuinely useful - End when the goal is achieved - Use imperative mood: "Configure the setting", "Add the following" **Avoid**: Teaching fundamentals, explaining every detail, being exhaustive ### 3. Reference (Information-Oriented) **Purpose**: Provide accurate, complete technical descriptions of the system. - Organized by structure (CLI commands, configuration options, API en...

Details

Author
github
Repository
github/gh-aw
Created
1 years ago
Last Updated
today
Language
Go
License
MIT

Similar Skills

Semantically similar based on skill content — not just same category