We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
1 parent 819dbfd commit 0aff041Copy full SHA for 0aff041
2 files changed
docs/AGENTS.md
@@ -2,6 +2,11 @@
2
3
## General
4
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.
10
- Document only public APIs and user-facing behavior - exclude internals, framework
11
abstractions, and implementation plumbing - Users need actionable documentation on
12
what they can use, not confusing details about internal mechanics they can't control
docs/CLAUDE.md
0 commit comments