docs: restructure B20 guides and rewrite execution architecture (base-std@be6d045) - #1928
Closed
github-actions[bot] wants to merge 1 commit into
Closed
docs: restructure B20 guides and rewrite execution architecture (base-std@be6d045)#1928github-actions[bot] wants to merge 1 commit into
github-actions[bot] wants to merge 1 commit into
Conversation
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Automations to automatically generate PRs for you. |
Collaborator
🟡 Heimdall Review Status
|
Contributor
|
Closing unmerged. The route table mapped only the six files base-std#213 deleted and none of the fifteen it added, so this PR edited reference pages from an all-minus diff (13 "source file removed" banners, and a wrong claim that |
soheimam
added a commit
that referenced
this pull request
Sep 8, 2026
…ed files (#1938) * Route the base-std docs tree and report unrouted or removed sources base-std#213 (be6d045) deleted the flat docs/B20, docs/PolicyRegistry and docs/ActivationRegistry pages and added an audience-layered docs/ tree. The route table mapped only the six deleted files, so the sync edited their target pages from an all-minus diff (adding "source file removed" banners to reference pages generated from an unchanged interface) and dropped the fifteen new files without a trace (#1928). Route table - Retire the rules for the deleted files. Add rules for overview.md, architecture.md, concepts/*, guides/*, reference/*, placed where docs/ia-guidelines.md and docs/content-guidelines.md put that content: chain-generic precompile mechanics on Base Protocol > Execution, the B20 component map and key concepts on the specification overview, execution and versioning guarantees on the invariants page, how-to guides on the existing Build on Base task pages, reference tables on the B20 supporting pages. - New `ignored` kind for upstream scaffolding (README, guide template, interface link index) so it stays out of the unrouted report. Sync script - `removed_paths`: derived by the workflow from the commit API for the verified sha (renames count their previous name). Removed files never route. - `classifyChangedPaths` buckets every changed path as routed, ignored, unrouted or removed; the PR body gains "Unrouted source files" and "Removed source files" sections. When nothing routes, the workflow files the report as an issue, one per source sha. - Placement proposals: unrouted Markdown sources go through one Haiku call that reads the IA and content guidelines plus the existing Specifications and Build on Base page list, and names the existing page each file belongs on with the guideline rule that decides it. Proposals are filtered against the candidate list; nothing creates a page. GUIDELINE_ROUTING=apply also edits the proposed pages. - `validateCallouts` rejects Warning/Note/Info/Tip callouts that talk about source files, restructures or "last known state"; prompt rules 10 and 11 say the same and let the sync replace a "Generated B20 reference for" placeholder description. Tests cover the new routes against the real be6d045 file list, removed path exclusion, classification, proposal filtering, the routing report and the callout guard. Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01VNDYZpZXLaTr6iQraqkXyf * Harden the routing report and removed_paths handling Only hyperlink source paths made of plain path characters in the routing report; anything else renders as inert code so a crafted filename cannot close the markdown link. Cap removed_paths in the script (200 entries, 512 bytes each) and make the workflow overwrite the field for every non-release dispatch, so the payload can never supply it. Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01VNDYZpZXLaTr6iQraqkXyf --------- Co-authored-by: Claude Fable 5.1 <noreply@anthropic.com>
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
2 participants
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.
Auto-generated from the source PR above.
Reviewer checklist
Before merging, confirm each item below. The validator catches structural problems (raw HTML, dangerous URLs, secrets); these items need a human eye.
click here, no link text that contradicts its target host.title/descriptionstill match the page's role (reference vs. overview vs. conceptual).<Warning>added describes a real breaking change in the source PR, not a paraphrase the model invented.Newly introduced external URLs
docs/specifications/b20/reference/interfaces/ib20-asset/announce.mdxdocs/specifications/b20/reference/interfaces/ib20-asset/update-ui-multiplier.mdxFiles touched
docs/specifications/b20/reference/interfaces/ib20-asset/announce.mdxdocs/specifications/b20/reference/interfaces/ib20-asset/balance-of-ui.mdxdocs/specifications/b20/reference/interfaces/ib20-asset/batch-mint.mdxdocs/specifications/b20/reference/interfaces/ib20-asset/effective-at.mdxdocs/specifications/b20/reference/interfaces/ib20-asset/extra-metadata.mdxdocs/specifications/b20/reference/interfaces/ib20-asset/from-ui-amount.mdxdocs/specifications/b20/reference/interfaces/ib20-asset/multiplier.mdxdocs/specifications/b20/reference/interfaces/ib20-asset/new-ui-multiplier.mdxdocs/specifications/b20/reference/interfaces/ib20-asset/scaled-balance-of.mdxdocs/specifications/b20/reference/interfaces/ib20-asset/to-raw-balance.mdxdocs/specifications/b20/reference/interfaces/ib20-asset/to-scaled-balance.mdxdocs/specifications/b20/reference/interfaces/ib20-asset/to-ui-amount.mdxdocs/specifications/b20/reference/interfaces/ib20-asset/total-supply-ui.mdxdocs/specifications/b20/reference/interfaces/ib20-asset/ui-multiplier.mdxdocs/specifications/b20/reference/interfaces/ib20-asset/update-multiplier.mdxdocs/specifications/b20/reference/interfaces/ib20-asset/update-ui-multiplier.mdxdocs/specifications/b20/reference/interfaces/ib20-factory/get-b20-address.mdxdocs/specifications/b20/reference/constants-addresses.mdxdocs/specifications/b20/reference/interfaces/ib20-stablecoin/currency.mdxdocs/specifications/b20/reference/interfaces/i-policy-registry/composite-policy-child-ids.mdxdocs/specifications/b20/reference/interfaces/i-policy-registry/create-composite-policy.mdxdocs/specifications/b20/reference/interfaces/i-policy-registry/create-policy.mdxdocs/specifications/b20/reference/interfaces/i-policy-registry/finalize-update-admin.mdxdocs/specifications/b20/reference/interfaces/i-policy-registry/is-authorized.mdxdocs/specifications/b20/reference/interfaces/i-policy-registry/max-composite-child-policies.mdxdocs/specifications/b20/reference/interfaces/i-policy-registry/pending-policy-admin.mdxdocs/specifications/b20/reference/interfaces/i-policy-registry/policy-admin.mdxdocs/specifications/b20/reference/interfaces/i-policy-registry/policy-exists.mdxdocs/specifications/b20/reference/interfaces/i-policy-registry/renounce-admin.mdxdocs/specifications/b20/reference/interfaces/i-policy-registry/stage-update-admin.mdxdocs/specifications/b20/reference/interfaces/i-policy-registry/update-allowlist.mdxdocs/specifications/b20/reference/interfaces/i-policy-registry/update-blocklist.mdxSource provenance
Each row shows which file(s) in
base/base-std@be6d045drove an edit to a docs page. Click into a source file to verify the claim before merging.docs/specifications/b20/reference/interfaces/ib20-asset/announce.mdxdocs/B20/Asset.mddocs/specifications/b20/reference/interfaces/ib20-asset/balance-of-ui.mdxdocs/B20/Asset.mddocs/specifications/b20/reference/interfaces/ib20-asset/batch-mint.mdxdocs/B20/Asset.mddocs/specifications/b20/reference/interfaces/ib20-asset/effective-at.mdxdocs/B20/Asset.mddocs/specifications/b20/reference/interfaces/ib20-asset/extra-metadata.mdxdocs/B20/Asset.mddocs/specifications/b20/reference/interfaces/ib20-asset/from-ui-amount.mdxdocs/B20/Asset.mddocs/specifications/b20/reference/interfaces/ib20-asset/multiplier.mdxdocs/B20/Asset.mddocs/specifications/b20/reference/interfaces/ib20-asset/new-ui-multiplier.mdxdocs/B20/Asset.mddocs/specifications/b20/reference/interfaces/ib20-asset/scaled-balance-of.mdxdocs/B20/Asset.mddocs/specifications/b20/reference/interfaces/ib20-asset/to-raw-balance.mdxdocs/B20/Asset.mddocs/specifications/b20/reference/interfaces/ib20-asset/to-scaled-balance.mdxdocs/B20/Asset.mddocs/specifications/b20/reference/interfaces/ib20-asset/to-ui-amount.mdxdocs/B20/Asset.mddocs/specifications/b20/reference/interfaces/ib20-asset/total-supply-ui.mdxdocs/B20/Asset.mddocs/specifications/b20/reference/interfaces/ib20-asset/ui-multiplier.mdxdocs/B20/Asset.mddocs/specifications/b20/reference/interfaces/ib20-asset/update-multiplier.mdxdocs/B20/Asset.mddocs/specifications/b20/reference/interfaces/ib20-asset/update-ui-multiplier.mdxdocs/B20/Asset.mddocs/specifications/b20/reference/interfaces/ib20-factory/get-b20-address.mdxdocs/B20/Factory.mddocs/specifications/b20/reference/constants-addresses.mdxdocs/B20/README.mddocs/specifications/b20/reference/interfaces/ib20-stablecoin/currency.mdxdocs/B20/Stablecoin.mddocs/specifications/b20/reference/interfaces/i-policy-registry/composite-policy-child-ids.mdxdocs/PolicyRegistry/README.mddocs/specifications/b20/reference/interfaces/i-policy-registry/create-composite-policy.mdxdocs/PolicyRegistry/README.mddocs/specifications/b20/reference/interfaces/i-policy-registry/create-policy.mdxdocs/PolicyRegistry/README.mddocs/specifications/b20/reference/interfaces/i-policy-registry/finalize-update-admin.mdxdocs/PolicyRegistry/README.mddocs/specifications/b20/reference/interfaces/i-policy-registry/is-authorized.mdxdocs/PolicyRegistry/README.mddocs/specifications/b20/reference/interfaces/i-policy-registry/max-composite-child-policies.mdxdocs/PolicyRegistry/README.mddocs/specifications/b20/reference/interfaces/i-policy-registry/pending-policy-admin.mdxdocs/PolicyRegistry/README.mddocs/specifications/b20/reference/interfaces/i-policy-registry/policy-admin.mdxdocs/PolicyRegistry/README.mddocs/specifications/b20/reference/interfaces/i-policy-registry/policy-exists.mdxdocs/PolicyRegistry/README.mddocs/specifications/b20/reference/interfaces/i-policy-registry/renounce-admin.mdxdocs/PolicyRegistry/README.mddocs/specifications/b20/reference/interfaces/i-policy-registry/stage-update-admin.mdxdocs/PolicyRegistry/README.mddocs/specifications/b20/reference/interfaces/i-policy-registry/update-allowlist.mdxdocs/PolicyRegistry/README.mddocs/specifications/b20/reference/interfaces/i-policy-registry/update-blocklist.mdxdocs/PolicyRegistry/README.mdOpened by
Apply Base Std Updateworkflow.