Composio powers 1000+ toolkits, tool search, context management, authentication, and a sandboxed workbench to help you build AI agents that turn intent into action.

next
md 44 lines 1.61 KB
Rendered Raw
1 # Docs Workflow
2
3 ## Entry Points
4
5 - Read `docs/AGENTS.md` before editing docs.
6 - Docs context lives in `docs/agent-guidance/context/`.
7 - Docs automation prompts live in `docs/agent-guidance/agents/`.
8 - Changelog guidance lives in `docs/agent-guidance/guides/changelog.md`.
9 - Decisions live in `docs/decisions/`.
10
11 ## Commands
12
13 Run from `docs/`:
14
15 ```bash
16 bun run build
17 bun run types:check
18 bun run lint
19 bun run lint:links
20 bun run test
21 bun run test:integration
22 bun run generate:toolkits
23 bun run generate:meta-tools
24 bun run generate:api-index
25 bun run check:code-examples
26 bun run check:api-snippets
27 bun run check:python-snippets
28 bun run test:python-snippets
29 bun run check:typescript-snippets
30 bun run inventory:code-examples
31 ```
32
33 ## Rules
34
35 - Branch docs work from `next` and target PRs at `next`.
36 - Production Twoslash and the standalone TypeScript snippet gate cover different maintained surfaces. Read the Twoslash context before changing typed examples.
37 - Maintained operations offer Python, TypeScript, and API options or a specific justified exception. Read `docs/agent-guidance/context/code-examples.md` for scope, generated/historical limits, and narrow markers. Static checks do not prove equivalence or exemption reasons.
38 - Use relative site links, not absolute docs URLs, for internal links.
39 - Generated OpenAPI, toolkit, and meta-tool data should be changed through their scripts.
40 - Prefer cURL for API interactions because docs are read by humans and agents.
41
42 ## Automation
43
44 When changing docs automation prompts, update the workflow prompt paths under `.github/workflows/` and run the agent-skill validator to catch stale guidance references.