@devries-cameron20 / composio Mirror · read-only
Fork 0

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

Mirrored from https://github.com/Camo67/composio.git

Synced Nov 21, 04:45 UTC

next
md 1.61 KB

Docs Workflow

Entry Points

  • Read docs/AGENTS.md before editing docs.
  • Docs context lives in docs/agent-guidance/context/.
  • Docs automation prompts live in docs/agent-guidance/agents/.
  • Changelog guidance lives in docs/agent-guidance/guides/changelog.md.
  • Decisions live in docs/decisions/.

Commands

Run from docs/:

bun run build
bun run types:check
bun run lint
bun run lint:links
bun run test
bun run test:integration
bun run generate:toolkits
bun run generate:meta-tools
bun run generate:api-index
bun run check:code-examples
bun run check:api-snippets
bun run check:python-snippets
bun run test:python-snippets
bun run check:typescript-snippets
bun run inventory:code-examples

Rules

  • Branch docs work from next and target PRs at next.
  • Production Twoslash and the standalone TypeScript snippet gate cover different maintained surfaces. Read the Twoslash context before changing typed examples.
  • 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.
  • Use relative site links, not absolute docs URLs, for internal links.
  • Generated OpenAPI, toolkit, and meta-tool data should be changed through their scripts.
  • Prefer cURL for API interactions because docs are read by humans and agents.

Automation

When changing docs automation prompts, update the workflow prompt paths under .github/workflows/ and run the agent-skill validator to catch stale guidance references.