The best way to control Claude Code, Codex and more from any computer or phone

main
md 44 lines 1.69 KB
Rendered Raw
1 # AI docs
2
3 `LLMS.md` is generated from `ai-docs/src`.
4
5 ## Add content
6
7 1. Add or update markdown in `ai-docs/src/**/index.md` for section intro text.
8 2. Add examples as `.ts` files in the same folder.
9 3. Run `pnpm ai-docgen` to regenerate `LLMS.md`.
10
11 ## Source file conventions
12
13 - Use numeric filename prefixes to control ordering (`10_`, `20_`, etc). Avoid starting with `0` unless explicity requested to do so.
14 - Use a top JSDoc block with `@title` and optional description to control rendered title/description.
15 - `fixtures` directories are ignored and not included in the generated
16 documentation. Use them for any supporting code or data needed for examples.
17
18 ## Example guidelines
19
20 Before writing an example, look at the existing examples in `ai-docs/src` to
21 learn the style and conventions used in this project. Also read the current
22 `LLMS.md` to understand the content and style of the documentation.
23
24 **All code examples should be well commented** explaining the how and why of the
25 code, not just what the code is doing. The goal is to teach users how to use the
26 API.
27
28 **Code must represent real world usage and best practices.**
29 Do not include toy examples that are not representative of how the API should be
30 used in practice.
31
32 - **Prefer using the service style** of structuring code, as this represents real
33 world usage and best practices.
34 - Use the `fixtures` directory to illustrate / suggest best practices for
35 project structure, file organization, and code organization.
36
37 Pull requests with only ai documentation changes **DO NOT** need a changeset.
38
39 ## Regeneration
40
41 - One-shot: `pnpm ai-docgen`
42 - Watch mode: `pnpm ai-docgen:watch`
43
44 `pnpm ai-docgen` regenerates `LLMS.md` files from content in `ai-docs/src`.