Remove OZ token example pages, link to OZ docs - #2705
Conversation
This comment was marked as resolved.
This comment was marked as resolved.
|
Preview is available here: |
This comment was marked as resolved.
This comment was marked as resolved.
There was a problem hiding this comment.
Pull request overview
Removes outdated duplicated OpenZeppelin token examples while directing readers to maintained upstream documentation.
Changes:
- Deletes fungible and NFT example pages.
- Adds OpenZeppelin links to the Tokens guide.
- Adds permanent redirects for removed routes and reclassifies the Whisk callout.
Recommendation: MERGE-READY — correct, complete, nothing needs a human.
Reviewed changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
routes.txt |
Removes deleted routes. |
nginx/includes/redirects.conf |
Redirects removed URLs to Tokens. |
docs/build/smart-contracts/example-contracts/tokens.mdx |
Adds current OpenZeppelin guidance. |
docs/build/smart-contracts/example-contracts/fungible-token.mdx |
Removes stale duplicated example. |
docs/build/smart-contracts/example-contracts/non-fungible-token.mdx |
Removes stale duplicated example. |
|
Preview is available here: |
ElliotFriend
left a comment
ElliotFriend
left a comment
There was a problem hiding this comment.
i like the looks of this! i think it's a reasonable approach to take for the outdated OZ tutorials. left some thoughts, though nothing is blocking. would love to hear some thoughts from others
|
Elliot covered most of the bases, and I'm supportive of this change. Much easier to reference their docs than try to mirror them for eternity. My suggestion removed the "audited" bit because those only apply to specific library releases (the latest RC just came out, e.g., and is not yet audited). A link to the docs can and has drifted, since the last v0.7.0 check doesn't cover the current v0.7.2 release—something which should be apparent in the standard OZ docs, along with firm documentation. |
|
Warning This change removes routes. The diff of routes is below. Please verify that these changes to the routes are intentional and that redirects are in place if needed. Redirects can be added to diff --git a/routes.txt b/routes.txt
index 7989cd7e..9f0304cc 100644
--- a/routes.txt
+++ b/routes.txt
@@ -173,12 +173,10 @@
/docs/build/smart-contracts/example-contracts/deployer
/docs/build/smart-contracts/example-contracts/errors
/docs/build/smart-contracts/example-contracts/events
-/docs/build/smart-contracts/example-contracts/fungible-token
/docs/build/smart-contracts/example-contracts/fuzzing
/docs/build/smart-contracts/example-contracts/liquidity-pool
/docs/build/smart-contracts/example-contracts/logging
/docs/build/smart-contracts/example-contracts/mint-lock
-/docs/build/smart-contracts/example-contracts/non-fungible-token
/docs/build/smart-contracts/example-contracts/simple-account
/docs/build/smart-contracts/example-contracts/single-offer-sale
/docs/build/smart-contracts/example-contracts/storage
|
|
Preview is available here: |
What
Remove the Fungible Token and Non-Fungible Token example pages and instead add a tip at the top of the Tokens example linking to OpenZeppelin's fungible and non-fungible token docs, with nginx redirects sending the removed URLs to the Tokens page.
Why
The two pages duplicated OpenZeppelin's examples and had drifted out of date (dead
examples/fungible-token-interfacepaths, moved modules, stale macros), and per the discussion in #2691 the docs shouldn't mirror examples that OpenZeppelin already maintains — the Tokens example keeps showing how to build a token with only thesoroban-sdk, while the tip gives the fast path.The whisk changes box is changed to a note because it's not really a tip rather just information about this example and having two tips at the top is harder to process.
Close #2691