You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
[task] Convert guides to task-oriented how-to documentation #1453
Transform existing guides into clear, task-oriented how-to documentation that shows users how to solve specific problems.
Context
The scout report identifies that current "Guides" and "Application Areas" overlap in purpose. Diátaxis recommends how-to guides be focused on solving specific tasks, with clear prerequisites and outcomes.
Approach
Audit existing guides in docs/src/content/docs/guides/ and map to specific tasks
Rewrite guides to follow how-to structure:
Clear task statement (e.g., "How to configure network permissions")
Prerequisites listed upfront
Step-by-step instructions
Expected outcome/verification step
Move content to docs/src/content/docs/how-to/ directory
Ensure each guide addresses a single task
Example how-to topics:
How to debug workflow failures
How to configure safe outputs for issue creation
How to use custom MCP servers
How to restrict network access
How to implement ChatOps bots
How to handle workflow permissions
Files to Modify/Create
Migrate: Content from docs/src/content/docs/guides/ to docs/src/content/docs/how-to/
Activity