Repository navigation
Docs: drop removed behaviour; refresh diagrams and known issues - #327
Merged
Merged
Conversation
Slice 3 of the documentation refresh plan. Removed behaviour: failed-issuance units are burned by the final payCoupon rather than withdrawn (ARCHITECTURE), BOND_MANAGER_ROLE lists the functions it actually gates (contracts-security), the NB Bond API component view says "coupon and closure" instead of redeem, the runtime diagram no longer claims reserved ports 443 and 8546, the ingestion database list names real routes instead of /holders, and BENS is documented as deployed by blockscout.sh rather than a nonexistent bens-microservice.sh. services/AGENTS.md now lists nb-ui, and two link labels match their targets. Diagrams: the startup flow shows the resume of a stopped node and that contracts deploy only when not already deployed on the chain; the bond lifecycle classifier matches bondStatus (outstanding while supply or coupon periods remain). Known issues: the reopen entry becomes "Closed and finalised auctions cannot be reopened" (heading keeps "reopen" so AZURE_BOUNDARY.md stays accurate), the resolved ingestion entry is removed, the sample error no longer pins an ethers version, and two BENS follow-ups recorded only in an archived plan get their own entries. progress.md marks Phase 2 merged as #326.
5 tasks done
Greaker
added a commit
that referenced
this pull request
Oct 27, 2026
Slice 4 of the documentation refresh plan. The 30 committed NatSpec pages linked their sources to blob/<commit>/src/... on GitHub: the path lacked the contracts/ prefix and the commit is on no branch, so every link was a 404, and the link checker skips http links. fix-links.py now rewrites each Git Source link into a link relative to the page, pointing at contracts/src/, and rewrites the homepage's relative links (a copy of contracts/README.md) only when they do not already resolve, so a second run changes nothing. It is applied to the committed pages: one line per page. Foundry 1.8.6 no longer emits mdBook Markdown; forge doc now writes a Vocs site scaffold. The committed mdBook pages stay the maintained reference, so the natspec README, contracts/README.md, and its homepage copy no longer tell readers to run forge doc. progress.md marks Phase 3 merged as #327 and records the Foundry change.
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.
Summary
docs/plans/documentation-refresh/. Removed behaviour no longer documented: failed-issuance units are burned by the finalpayCoupon(ARCHITECTURE);BOND_MANAGER_ROLElists the functions it gates (contracts-security); "coupon and closure" instead of redeem in the NB Bond API component view; no reserved 443/8546 ports in the runtime diagram; real routes instead of/holders; BENS is deployed byblockscout.sh start(there is nobens-microservice.sh).services/AGENTS.mdlists nb-ui; two link labels match their targets.sandbox-startup-flow.mdshows the resume of a stopped node and that contracts deploy only when not already deployed on the chain;bond-lifecycle.mdmatchesbondStatus(outstanding while supply or coupon periods remain).docs/AZURE_BOUNDARY.mdstays accurate); the resolved ingestion entry is removed; the sample error no longer pins an ethers version; two BENS follow-ups recorded only in an archived plan get their own entries.progress.mdmarks Phase 2 merged as Plan housekeeping: archive ERC-3643 plan, park three plans #326 and records the slice 3 deviations.Documentation only.
Test plan
python3 scripts/verification/check-public-repo-hygiene.pypython3 scripts/verification/check-markdown-links.pynpm run format:check -w nb-bond-apidocs/AZURE_BOUNDARY.md, and nb-ui files owned by the nb-ui plansandbox-startup-flow.mdandbond-lifecycle.mdrender on the rich diff