Repository navigation
Update V3 release documentation through 3.1.1 - #685
Merged
Merged
Conversation
The current index named 3.1.0 while the core reference pages still contained 3.0.4 documentation. Restore accurate release documentation and make future generation use explicit source commits. - Preserve the existing 3.0.4 pages in the deprecated archive - Generate 3.1.0 historical pages and 3.1.1 current pages - Record core release commits and independent periphery snapshots - Validate complete output before replacing current documentation - Fix Vyper overload tables and generated Markdown links - Document the V3 compiler setup and add generator regression checks Validated eight regression checks, the full site build, preserved archive hashes, and 3,453 rendered internal links.
|
Review the following changes in direct dependencies. Learn more about Socket for GitHub.
|
|
Deploy preview for yearn-docs ready!
Deployed with vercel-action |
9 tasks done
engn33r
reviewed
Oct 12, 2026
engn33r
left a comment
engn33r
left a comment
Collaborator
There was a problem hiding this comment.
overall lgtm. Definitely needed to update the version to 3.1.1 and add 3.0.4 and 3.1.0 to the deprecated list, as done here. The other minor improvements are also nice to haves.
| "commit": "358d074ce333f149b5046b4e949c196881523d22" | ||
| }, | ||
| "tokenized-strategy-periphery": { | ||
| "commit": "ab942b245c611cf9747e541ab03b36770c610966" |
Collaborator
There was a problem hiding this comment.
FYI this is 3.0.4 but only because that is the latest release
| "commit": "48c53aba0395885b3f579d0a4b426de276a7b69e" | ||
| }, | ||
| "vault-periphery": { | ||
| "commit": "358d074ce333f149b5046b4e949c196881523d22" |
Collaborator
There was a problem hiding this comment.
FYI this commit is 3.0.4 but only because that is the latest release
rossgalloway
added a commit
that referenced
this pull request
Oct 19, 2026
Merge master after #685 while preserving the NatSpec and address-check test commands. Refresh the live report; the registry still reports 3.1.0 and does not list 3.1.1.
This branch was successfully deployed
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
The current contract index said 3.1.0, but the core reference pages still documented 3.0.4. This updates the 3.1.1 release addresses and generated contract reference pages, adds the missing 3.1.0 reference, and preserves the previous 3.0.4 pages under Deprecated.
The NatSpec generator now uses recorded source commits, checks both core API versions, and requires every expected page before replacing published documentation. It also fixes Vyper parameter tables for optional arguments, generated links, and Markdown rendering.
How to review
src/ethereum/constants.tsanddocs/developers/addresses/v3-contracts.md.natspec/releases.json, the generator, and the updated README setup. Core contracts use release tags resolved to exact commits. Periphery pages use independently pinned snapshots as of each vault release commit.docs/developers/smart-contracts/V3for current 3.1.1 pages anddeprecated/V3/version-3.1.0for the generated historical set. Each contains 22 contract pages and a source manifest.deprecated/V3/version-3.0.4are byte-identical to the previously published pages. Their new index explains the corrected version label and historical source coverage. The existing 3.0.3 archive is unchanged.For local regeneration, activate a V3 environment with Vyper 0.3.10 using
natspec/requirements.txt, then runbun run v3-docs --version 3.1.1. The root V2 compiler requirements remain separate.Test plan
bun run test:natspec— all eight regression checks passed.bun run build— website build and AI exports passed.git diff --checkpassed for the updated files.Risk / impact
This changes documentation, release-address constants, and local documentation tooling. The generator checks out pinned source and dependency commits and requires the matching Vyper compiler. Periphery snapshots have independent release schedules, so the source manifests and index pages state their provenance. Reverting this PR restores the previous documentation and generation workflow.