fix(docs): add references frontmatter to documentation files #19447
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
referencesfrontmatter to 28 documentation files that include code snippets via#include_codemacrosdocs/scripts/extract_references.shto extract references from documentation filescheck_doc_references.shto support directory references with/*suffixdocs/README.mdwith documentation about the references formatdocs/CLAUDE.mdwith reminder about updating docs when changing processesFiles Updated
counter_contract.md,token_contract.mdaztecjs-getting-started.md,token_bridge.mdaztec-nr/filestransactions.md,state_management.md,wallets.md,fees.md,call_types.md,keys.mdHow It Works
Documentation files can now declare source code dependencies via frontmatter:
Directory references use
/*suffix to indicate all files within that directory:When any file within that directory changes, the documentation will be flagged for review.
When referenced paths change in a PR,
docs/scripts/check_doc_references.sh:@AztecProtocol/devrelas reviewersReference Format
"path/to/file.ts""path/to/directory/*"Test Plan
referencesfrontmatter🤖 Generated with Claude Code