fix: repair stale/broken links across 4 READMEs - #666
Conversation
Systematic sweep over every README.md/readme.MD/*.mdx in the repo (47 files, 119 relative links extracted and resolved against disk) found 4 files with genuinely broken content, each verified by hand against the current source it documents: - basics/close-account/anchor/README.md: the program was renamed from destroy-an-account to close-account (dir, file names, and implementation approach all changed - close_user.rs now uses a declarative `close = user` account constraint instead of the old imperative `.close()` call) but the README was never updated. Fixes 3 dead links and rewrites 2 stale code snippets plus the test-description prose to match what tests/test.ts actually does. - basics/favorites/anchor/README.md: link text and URL were swapped ([url](text) instead of [text](url)). - tokens/transfer-tokens/README.md: links to tokens/spl-token-minter and tokens/nft-minter, neither of which exist; repointed to the current equivalents, tokens/create-token and tokens/nft-operations. - tokens/token-2022/nft-meta-data-pointer/README.md: a copy-paste artifact had merged two separate links into one broken nested construct; restored the intended single link. Verified: re-ran the link sweep after editing - 0 broken links out of 119 (down from 7 broken across these 4 files before).
Greptile SummaryThe PR repairs stale or malformed documentation links and updates the close-account tutorial to match the current implementation.
Confidence Score: 5/5The documentation-only PR appears safe to merge. No blocking failure remains. Important Files Changed
Reviews (2): Last reviewed commit: "fix(#666): stop overpromising ATA covera..." | Re-trigger Greptile |
| You can use the `transfer()` function provided by the SPL Token Program to conduct a transfer of any SPL Token with the appropriate permissions. | ||
|
|
||
| Check out [SPL Token Minter](../spl-token-minter) or [NFT Minter](../nft-minter) to learn more about Associated Token Accounts. | ||
| Check out [Create an SPL Token](../create-token) or [NFT Operations](../nft-operations) to learn more about Associated Token Accounts. |
There was a problem hiding this comment.
The changed sentence directs readers to these examples to learn about Associated Token Accounts, but create-token does not cover ATAs and nft-operations only uses them incidentally. Describe them as related token and NFT examples instead so readers are not promised an explanation the targets do not provide.
| Check out [Create an SPL Token](../create-token) or [NFT Operations](../nft-operations) to learn more about Associated Token Accounts. | |
| Check out [Create an SPL Token](../create-token) and [NFT Operations](../nft-operations) for related token creation and NFT examples. |
Note: If this suggestion doesn't match your team's coding style, reply to this and let me know. I'll remember it for next time!
…er-tokens README Greptile review caught it: neither create-token nor nft-operations actually explains Associated Token Accounts (verified - neither README mentions ATAs at all), so pointing readers there "to learn more about Associated Token Accounts" was inaccurate. Reworded to describe them as related examples instead.
|
Good catch — neither example actually explains ATAs, so that was overpromising. Reworded per your suggestion in |
Summary
Ran a systematic sweep over every
README.md/readme.MD/*.mdxin the repo — 47 markdown files, 119 relative links extracted and resolved against disk — and found 4 files with genuinely broken content. Each was verified by hand against the current source it's supposed to document (not just a link-existence check).basics/close-account/anchor/README.md— the program was renamed fromdestroy-an-accounttoclose-account(directory, file names, and implementation approach all changed —close_user.rsnow uses a declarativeclose = useraccount constraint instead of the old imperative.close()call), but the README was never updated. This is the meatiest fix: 3 dead links, 2 stale code snippets rewritten to match current source, and the test-description prose corrected (the old README described checkingfetchNullableboth before creation and after closing; the current test only checks null after closing).basics/favorites/anchor/README.md— link text and URL were swapped:[url](text)instead of[text](url).tokens/transfer-tokens/README.md— links totokens/spl-token-minterandtokens/nft-minter, neither of which exists. Repointed to the current equivalents covering the same topics:tokens/create-tokenandtokens/nft-operations.tokens/token-2022/nft-meta-data-pointer/README.md— a copy-paste artifact had merged two separate links into one broken nested construct; restored the single intended cookbook link.All docs-only, zero code/build risk.
Test plan
git ls-files(what Linux CI sees, not macOS's case-insensitive filesystem)close-account/anchor/README.mdend-to-end againstcreate_user.rs,close_user.rs, andtests/test.tsto confirm the rewritten snippets/prose are accurate to current codedestroy-an-account,spl-token-minter,nft-minter) — none found outside these files