Skip to content

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

Merged
dprevost-LMI merged 1 commit into
webdriverio:mainfrom
dprevost-LMI:docs-sync-reminder
Sep 22, 2026
Merged

dprevost-LMI merged 1 commit into
webdriverio:mainfrom
dprevost-LMI:docs-sync-reminder

Conversation

@dprevost-LMI

@dprevost-LMI dprevost-LMI commented Sep 22, 2026 •

Copy link
Copy Markdown
Collaborator

packages/cddl/docs/*.md hand-documents the AST with worked examples and isn't generated from ast.ts/parser.ts, so nothing keeps it in sync automatically. Found stale twice in this session alone (IsFloat missing from references.md/ranges.md; two whole operators, the OperatorType union, and worked examples missing from operators.md) - both only caught by manual review. Write it down so it stops being a surprise.

…al sync

packages/cddl/docs/*.md hand-documents the AST with worked examples and
isn't generated from ast.ts/parser.ts, so nothing keeps it in sync
automatically. Found stale twice in this session alone (IsFloat missing
from references.md/ranges.md; two whole operators, the OperatorType
union, and worked examples missing from operators.md) - both only
caught by manual review. Write it down so it stops being a surprise.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
@dprevost-LMI dprevost-LMI changed the title docs: add a Docs section to AGENTS.md - packages/cddl/docs needs manu… docs: add a Docs section to AGENTS.md - packages/cddl/docs needs manual sync Sep 22, 2026
@greptile-apps

greptile-apps Bot commented Sep 22, 2026

Copy link
Copy Markdown

RetriggerConfidence Score: 5/5

The PR appears safe to merge as written.

Summary

Adds contributor guidance explaining that the CDDL AST documentation is manually maintained and must be reviewed whenever AST structures change.

  • Identifies packages/cddl/docs/ as the relevant documentation area.
  • Calls out worked examples and enumerated lists as synchronization points.
  • Records previous documentation drift as rationale for manual review.

Reviews (1) · Last reviewed commit: "docs: add a Docs section to AGENTS.md - ..."

@dprevost-LMI
dprevost-LMI merged commit 806a506 into webdriverio:main Sep 22, 2026
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant