Skip to content

docs: add a Docs section to AGENTS.md - packages/cddl/docs needs manual sync #114

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
dprevost-LMI merged 1 commit into from
Sep 22, 2026
Merged

docs: add a Docs section to AGENTS.md - packages/cddl/docs needs manual sync #114

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,18 @@ Each package has its own `.release-it.ts` (sharing common config from
`.release-it.base.ts`) and version — there is no monorepo-wide version to
keep in sync.

## Docs

`packages/cddl/docs/*.md` hand-documents the AST (`ast.ts`/`parser.ts`) with
worked examples — it is not generated, so nothing keeps it in sync
automatically. Any AST change (a new operator, a new field, a changed shape)
needs a matching doc update in the same PR: check `packages/cddl/docs/` for
the relevant file(s), not just the type declarations, but every worked
example and enumerated list. This isn't hypothetical — `references.md`/
`ranges.md` (missing `IsFloat`) and `operators.md` (missing two whole
operators, `OperatorType` union, numbered list, and worked examples) were
each found stale only by manual review, not by anything automated catching it.

## Setup

Node 24, pnpm pinned in `package.json#packageManager`.
Expand Down
Loading