docs: fix stale test commands, dead links, and convert finance README tables to prose#97
Merged
Merged
Conversation
- Replace `pnpm test` with `anchor test` in 42 Anchor example READMEs (these dirs have no package.json; CI runs `anchor test`). Drop the pointless `pnpm install` step and pnpm prerequisite from pure-Anchor examples that ship no JS client. - Rewrite stale [scripts] comments in create-token/nft-minter Anchor.toml that referenced removed bankrun/test.ts files and a wrong fixture name; describe the current LiteSVM + mpl_token_metadata.so fixture reality. - Remove vestigial [test] startup_wait and its false 'bankrun and validator tests' comment from token-extensions/basics (test is pure LiteSVM). - Delete orphan tests-rs/ under allow-block-list-token: its coverage is subsumed by the working test_abl_token.rs and its documented dep conflict no longer applies (repo is on solana 3.1.8). - Drop the stale 'Used in Professional Education' link from favorites.
…logy Tables in finance READMEs render badly in plain text, so convert them to prose bullets (`**key**: value` for concept/cast rows, backticked-key colon form for code identifiers). Remove all em-dashes in favour of commas, colons, or parentheses. Content, numbers, identifiers, math symbols, and links are preserved verbatim. Also fixes real terminology issues surfaced while editing: - perpetual-futures/anchor: 'on-chain' -> 'onchain' - token-swap: 'minus gas' -> 'minus transaction fees' - betting-market: reword the overclaimed 'trustless betting' (custody is bypass-proof, but outcome resolution is admin-trusted). Covers 12 finance READMEs; order-book/anchor and the two lending READMEs follow in the next commit.
Completes the finance README pass: order-book/anchor (16 tables), and the lending anchor/quasar READMEs (em-dashes). Wide tables are folded into prose bullets with labels drawn verbatim from the original column headers; all cell content, identifiers, numbers, and links preserved. Also swaps the two em-dashes in a lending/anchor shell-comment for hyphens.
Applies the same table->prose and em-dash cleanup to the Quasar CLOB port's README (two tables, prose em-dashes, and an 'on-chain' -> 'onchain' fix), so the finance docs are consistent.
'Outcome resolution is still trusted' is not idiomatic - you trust the admin, not the resolution. Reword to 'Resolution still requires trusting the admin, who chooses the winning outcome'.
mikemaccana
force-pushed
the
claude/solana-docs-cleanup
branch
from
3c96376 to
f0fea13
Compare
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
2 participants
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.
What this does
Documentation-only cleanup across the examples. No program or test code changes.
Stale test commands (42 Anchor READMEs)
These Anchor example dirs have no
package.json, and CI runsanchor test(Rust + LiteSVM), yet the READMEs told readers to runpnpm test— which has nothing to run. Replacedpnpm testwithanchor test, and dropped the pointlesspnpm installstep andpnpmprerequisite from the pure-Anchor examples that ship no JS client.Stale config comments
create-token/nft-minterAnchor.toml:[scripts]comments referenced removedbankrun/test.tsfiles and a wrong fixture name. Rewrote them to describe the current LiteSVM +mpl_token_metadata.sofixture.token-extensions/basicsAnchor.toml: removed a false "bankrun and validator tests" comment and the vestigial[test] startup_wait(the test is pure LiteSVM; peer examples carry no such block).Orphan tests
Deleted
allow-block-list-token/anchor/tests-rs/. Its coverage is subsumed by the workingtest_abl_token.rsin the canonical location, and the dependency conflict its README described no longer applies (the repo is on solana 3.1.8).Dead links
Removed the stale "Used in Solana Professional Education" link (deprecated repo, asserted current use). Contributor attribution links to original ports were kept.
Finance READMEs: tables → prose, no em-dashes
Markdown tables render badly in plain text, so every table in the finance READMEs is now a prose bullet list (
**key**: valuefor concept/cast rows, backticked-key colon form for code identifiers). All em-dashes are replaced with commas, colons, or parentheses. Every cell's content, numbers, identifiers, math symbols, and links are preserved verbatim.Also fixes real terminology issues surfaced during the pass:
on-chain→onchain(perpetual-futures, order-book/quasar)minus gas→minus transaction fees(token-swap)🤖 Generated with Claude Code
Generated by Claude Code