> Production API availability: use /api/v1/help?view=guides and the resource operations catalog before following a recipe. Some localhost capabilities are not deployed yet; an absent operation is unavailable.
Author in Docs
Use a Docs collection for the handbook. Create chapters with stable unique slugs, titles and sort order. Mark only intended public chapters as public. The generated projection selects public pages owned by the board owner from explicitly bound collections.
A public flag also makes a chapter eligible for the Docs module's own public view. It is not merely a hidden staging flag.
Bind the collection in Databoard
The saved board binding has this shape. The number is an example: use a collection owned by the target board's owner in that environment.
{
"website_settings": {
"Docs": { "collection_ids": [123] }
}
}Select the docs-modern template and map docs to publication. The page's presentation header selects doc_slug. Check the connection in Data Mapper before generating.
Synchronize chapter routes
GET /api/v1/databoards/{id}/docs-publication returns the board's owner-filtered public chapters. Compare their slugs with the board's existing routes using page-flow. New chapter routes require corresponding HMVC actions and mapped Docs sections, validated with the Databoard patch dry-run before applying.
There is not yet a dedicated HTTP operation that automatically synchronizes all chapter routes. Request maintainer assistance if the available board contract does not describe the necessary mapping. Do not assume an API-only agent can run internal publishing tools.
Update or withdraw content
Regeneration refreshes the published snapshot. After withdrawing a chapter and regenerating, it disappears from navigation and search; a retained chapter route renders an unavailable response with HTTP 404. Removing a chapter in the editor alone does not retract an already generated snapshot.
Use sync-data only when routes and templates already exist and you have verified that the intended projection is refreshed. Use generation when adding chapter routes or changing the renderer.
Current capabilities
The generated reader supports headings, paragraphs, flat lists, fenced code, inline code, emphasis and safe links. Raw HTML is escaped. It is not a complete CommonMark implementation. Search currently matches chapter titles, not full article text.
The Docs editor does not yet have a one-click publishing panel for the entire process. Chapter authoring uses the Docs editor; generated-site deployment uses the Databoard API. An owned Docs authoring API remains unavailable.
Reuse for technical repositories
Later, C-Kernel-Engine, LinuxUtilities and the drone flight controller can each have their own collection and destination board. Keep examples tied to a repository revision, prerequisites, tested commands and the output readers should expect.
Share the documentation renderer. Keep project-specific APIs, diagrams, version policy and release checks in the corresponding collection. A publishing pipeline does not automatically make repository commands or hardware procedures correct.