docs: make ENS use-case commands runnable; tighten docs checks and deterministic reference generation#899
Merged
MontrealAI merged 1 commit intomainfrom Feb 18, 2026
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Motivation
Description
npm test -- <file>examples indocs/INTEGRATIONS/ENS_USE_CASE.mdwith direct Truffle file-targeted commands (npx truffle test --network test test/adminOps.test.jsandnpx truffle test --network test test/mainnetHardening.test.js).docs/INTEGRATIONS/ENS.md,docs/INTEGRATIONS/ENS_ROBUSTNESS.md, anddocs/INTEGRATIONS/ENS_USE_CASE.mdto clarify trust boundaries, configuration model, and runbooks.scripts/docs/check-ens-docs.mjsto validate required sections/snippets, require a minimum number of Mermaid blocks, perform stricter SVG sanity checks (namespace, no scripts/external hrefs, no NULs), and improve relative link verification.scripts/docs/generate-ens-reference.mjsto filter non-existent source files, produce deterministic output (fixed generated timestamp), use stable sorting/uniqueness, and emit file/line anchors in the generateddocs/REFERENCE/ENS_REFERENCE.md.Testing
npm run docs:ens:checkwhich performs the new doc integrity checks (sections, Mermaid blocks, SVG, links, and reference generation) and it passed.node scripts/docs/generate-ens-reference.mjsand comparing output to the committeddocs/REFERENCE/ENS_REFERENCE.md, which matched (no stale reference error).node scripts/check-no-binaries.mjsto ensure no forbidden binary additions; it passed.Codex Task