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. |
| # Removed OpenZeppelin token example pages (https://github.com/stellar/stellar-docs/issues/2691) | ||
| rewrite ^/docs/build/smart-contracts/example-contracts/fungible-token$ "/docs/build/smart-contracts/example-contracts/tokens" permanent; | ||
| rewrite ^/docs/build/smart-contracts/example-contracts/non-fungible-token$ "/docs/build/smart-contracts/example-contracts/tokens" permanent; |
There was a problem hiding this comment.
The removed routes have been captured in redirects.
There was a problem hiding this comment.
How much value do you really think it adds to include the PR in the comments (as opposed to relying only on git blame)? I see it is in 3 of the 27 current sections, but I don't see a lot of use for it. If anything, it makes the headers quite lengthy and, by structural inertia, more difficult to add to as needed over time.
There was a problem hiding this comment.
i mean, it's at the end of the comment, so it's not really a hindrance to the necessary information. seems like it's a pretty minimal addition to provide some extra context on "why this section exists."
not sure how often people are actually git blameing in the docs, tbh. it's an extra step that many people might not even know how to effectively use.
There was a problem hiding this comment.
it makes the headers quite lengthy
What are the headers? Does the comment flow into anything? As I understand it the comment here has no impact on anything in the final built website.
There was a problem hiding this comment.
As I understand it the comment here has no impact on anything in the final built website.
that's correct. the commented lines in the nginx config are as inconsequential to the final product as // comments in javascript or # comments in python
There was a problem hiding this comment.
I think Elliot's reasoning makes sense. This file isn't exactly known for its conciseness. It just stood out to me as only partially implemented, and the past PRs doing it didn't discuss any reasoning.
|
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