Documentation
¶
Overview ¶
hack/generate-notes/main.go
Generates two outputs from the markdown doc files in pkg/note/docs/:
- pkg/note/catalog_generated.go — note registry for the Orkestra runtime and CLI
- documentation/reference/orkestra-notes/<domain>.md — user-facing reference pages
pkg/note/docs/ is the single source of truth. Run `make generate-notes` after adding or updating a doc file — both outputs are refreshed automatically.
Files containing an "## In Development" heading are excluded from both outputs until the feature is ready.
Usage:
go run ./hack/generate-notes make generate-notes
The generator parses every *.md file in docs/ and extracts note entries from ### `noteName` headings. The first non-empty paragraph after the heading becomes the description. The first fenced code block becomes the example. Some headings document two notes together using the form:
### `toLower` / `toUpper`
In that case both names are registered with the same description and example.
The domain is derived from the filename: "01-strings.md" → "strings".
Source Files