Skip to content

AGENTS.md

Latest commit

 

History

History
28 lines (23 loc) · 1.58 KB

AGENTS.md

File metadata and controls

28 lines (23 loc) · 1.58 KB
Raw

AGENTS.md

Contributor guide for agents working in this repository.

Co-located documentation rule

Documentation is co-located with the code it documents and is gathered into the docs site by builder docs:build. When a change alters a public contract, update the corresponding co-located doc in the SAME change:

  • A node's inputs, outputs, or config schema -> prose in nodes/src/nodes/<name>/README.md. Never hand-edit content between <!-- ROCKETRIDE:GENERATED:PARAMS START --> and <!-- ROCKETRIDE:GENERATED:PARAMS END -->; it is regenerated from services*.json by nodes:docs-generate.
  • A public TypeScript SDK signature -> packages/client-typescript/docs/. Reference under docs/reference/ is generated by client-typescript:docs-generate (do not edit).
  • A public Python SDK signature -> packages/client-python/docs/ (reference generated).
  • The MCP protocol surface -> packages/client-mcp/docs/.
  • The WebSocket (5565) / engine protocol surface -> packages/server/docs/.
  • The .pipe schema (packages/client-typescript/src/client/types/pipeline.ts) -> its reference regenerates to /pipeline-reference.
  • The VS Code extension surface -> apps/vscode/docs/.
  • Spine/landing pages (Home, Quickstart, Concepts, Cloud, Troubleshooting, Glossary, Cursor/Windsurf stubs) -> packages/docs/content-static/.

Prose-only edits and internal refactors that do not change a public contract do not require doc updates. Treat the doc as part of the change, not a follow-up. Do not create a separate docs repo or a top-level docs site folder. Verify with builder docs:build.