Skip to content

Commit 37e98e0

Browse files
timphandevclaude
andcommitted
docs: describe the structure of each package's section
Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
1 parent dc81048 commit 37e98e0

1 file changed

Lines changed: 17 additions & 0 deletions

File tree

‎docs/AGENTS.md‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,23 @@ GitHub Pages at `https://lynstack.github.io/recipe/`.
1818
in `src/components`.
1919
- Keep logic in `.ts` files, which are typechecked, and keep `.astro`
2020
files to markup.
21+
22+
## Structure of a package's section
23+
24+
- Every topic has the same groups, in this order: Get started, Concepts,
25+
Guides, API reference, and Resources. class-recipe also has Migrate.
26+
- Concepts explain, Guides show how to do a task, and API reference pages
27+
list a function's signature, config, and result. A rule belongs to one
28+
page; the others link to it.
29+
- The docs of class-recipe and native-recipe are complete without the
30+
engine's. They never require its words, such as "kind" or "reduce",
31+
and link to the engine only in an "Under the hood" aside.
32+
- The engine's section is for authors of libraries built on it.
33+
- Each package has a glossary, and defines a term, or links it there, the
34+
first time a page uses it. Quick starts and guides end with Next steps.
35+
- Never change a page's slug: the packages' TSDoc, READMEs, and skills
36+
link to them. When a section moves, keep a heading with its text where
37+
a link points to it, with a link to the new place.
2138
- The docs depend on React Native and its React types only to typecheck
2239
the recipes of `@lynstack/native-recipe`.
2340

0 commit comments

Comments
 (0)