Documentation workflow
Keep public documentation synchronized with user-visible Nodectra behavior.
The documentation application lives in the same repository as Nodectra but deploys independently to docs.nodectra.com.
Definition of done
A change must update documentation when it changes:
- a user-visible workflow or screen;
- a project object, port, property or validation rule;
- Runtime deployment or operational behavior;
- an API, MCP tool or security boundary;
- installation, configuration or troubleshooting steps.
Pure internal refactoring does not require a documentation edit when behavior and contracts remain unchanged.
Where content belongs
| Content | Location |
|---|---|
| Public product guidance | docs-app/content/docs |
| Internal audits and readiness reports | docs/ |
| Source-level implementation contract | Code and tests |
Do not copy internal security reports, real credentials, private infrastructure addresses or customer data into the public documentation application.
Local commands
bun install
bun run dev:docs
bun --cwd docs-app typecheck
bun run build:docsWriting rules
- Describe implemented behavior in present tense.
- Label previews, physical acceptance gaps and planned hardware explicitly.
- Use exact UI labels, object names and port names.
- Link related concepts instead of duplicating a source of truth.
- Update the page in the same commit as the feature whenever practical.