Skip to content

Commit 0aff041

Browse files
committed
Update docs authoring instructions
1 parent 819dbfd commit 0aff041

2 files changed

Lines changed: 5 additions & 1 deletion

File tree

docs/AGENTS.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,11 @@
22

33
## General
44

5+
- The structure of the documentation follows https://diataxis.fr/. When writing or
6+
editing an article, read the relevant guidance from the Diataxis Framework before:
7+
https://diataxis.fr/tutorials, https://diataxis.fr/how-to-guides/,
8+
https://diataxis.fr/explanation/, https://diataxis.fr/reference/.
9+
https://diataxis.fr/compass/ tells you where belongs what and how do they relate.
510
- Document only public APIs and user-facing behavior - exclude internals, framework
611
abstractions, and implementation plumbing - Users need actionable documentation on
712
what they can use, not confusing details about internal mechanics they can't control

docs/CLAUDE.md

Lines changed: 0 additions & 1 deletion
This file was deleted.

0 commit comments

Comments
 (0)