Skip to content

Latest commit

 

History

History
26 lines (19 loc) · 582 Bytes

File metadata and controls

26 lines (19 loc) · 582 Bytes

Documentation (Diataxis)

Keep docs short and practical.

Structure

  • docs/tutorials/: learning by doing
  • docs/how-to/: task steps
  • docs/reference/: facts, inputs, outputs
  • docs/explanation/: rationale and trade-offs

Pages

  • How-to:
    • docs/how-to/use-add-issue-to-projects-workflow.md
    • docs/how-to/use-add-pr-to-projects-workflow.md
  • Reference:
    • docs/reference/reusable-workflows.md
  • Explanation:
    • docs/explanation/README.md

Rules

  • Put all docs under docs/.
  • Pick one category per page.
  • Prefer concise examples over long prose.