Knowledge
Search knowledge... ⌘K
Knowledge · Framework · Capabilities
Documentation
Knowledge capture — godoc, JSDoc, usage examples, contract documentation.
Overview
Knowledge capture — godoc, JSDoc, usage examples, contract documentation.
Documentation produces human-readable artifacts that describe system behavior and design intent. In SBX, the model-is-documentation principle means that package.yml, entity descriptors, and capability narratives serve as the primary documentation — not separate markdown files. Generated documentation derives from models, ensuring it never drifts from implementation.
Layer Guidance
- PD
- Godoc: ValidateEntity validates entity fields
- MD
- Godoc: Create inserts a new document, returns created record
- SI
- OpenAPI: POST /api/documents — 201 Created, 400 Error
- UI
- Storybook: DocumentForm with mock data and error states
Examples
- Capability descriptor as documentation .framework/protocols/capability-descriptor/