Skip to content

docs: link canonical Solana terms to terminology page on first mention#30

Merged
mikemaccana merged 1 commit into
quicknode:mainfrom
mikemaccana-edwardbot:chore/readmes-link-solana-terminology
May 14, 2026
Merged

docs: link canonical Solana terms to terminology page on first mention#30
mikemaccana merged 1 commit into
quicknode:mainfrom
mikemaccana-edwardbot:chore/readmes-link-solana-terminology

Conversation

@mikemaccana-edwardbot
Copy link
Copy Markdown

@mikemaccana-edwardbot mikemaccana-edwardbot commented May 14, 2026

What

Walked every README in the repo and added a markdown link to https://solana.com/docs/terminology for the first prose mention of each canonical Solana term: program, instruction, instruction handler, account, PDA, mint / mint account, token account, ATA, rent, lamport, CPI / cross-program invocation, Token Extensions, onchain, Anchor, Classic Token Program.

Why

Readers new to Solana can click straight from any example into the canonical definition of unfamiliar terms without leaving the repo.

Rules followed

  • First prose mention only. Subsequent mentions in the same file stay plain.
  • Code blocks, inline code, headers, and pre-existing markdown links untouched.
  • Case-preserving link text. "Programs" stays "Programs", "PDA" stays "PDA".
  • One link per anchor per README. "instruction handler" and "mint account" link once; their constituents ("instruction", "mint") are linked at their next standalone prose mention.
  • No mid-name linking. "program" is not linked inside compound proper nouns like "System Program", "Token Program", or "Classic Token Program" (would read oddly mid-name).

Anchor corrections vs the original spec

Fetched https://solana.com/docs/terminology and verified every id= heading. The following corrections were applied vs the originally-supplied anchor list:

Term Spec anchor Live page anchor
program-derived address / PDA #program-derived-account #program-derived-address-pda
mint account / mint #mint-account #token-mint
associated token account / ATA #associated-token-account #associated-token-account-ata
Token Extensions #token-extensions #token-extensions-program
Classic Token Program (none in spec) #token-program

The Solana terminology page uses the older shorter name "Token Program" under the #token-program anchor; the concept is the same — this is the classic SPL token program, as opposed to Token Extensions, which has its own #token-extensions-program anchor.

Deliberately unlinked

  • signer — the terminology page has #signature but no #signer anchor.
  • offchain — the terminology page has #onchain (which explicitly notes "Onchain (no hyphen) is the preferred spelling") but no standalone #offchain anchor.

These terms were left unlinked rather than pointed at wrong or approximate targets. This is an omission on the Solana terminology page itself, not an oversight in this PR.

Stats

  • 40 READMEs changed — 166 links added (161 in the original pass + 5 Classic Token Program links).
  • 5 anchor corrections / additions applied vs the originally-supplied list.
  • Zero non-README files touched.

What
- Walked every README in the repo and added a markdown link to
  https://solana.com/docs/terminology for the first prose mention of each
  canonical Solana term: program, instruction, instruction handler, account,
  PDA, mint / mint account, token account, ATA, rent, lamport, CPI / cross-program
  invocation, Token Extensions, onchain, Anchor, Classic Token Program.

Why
- Readers new to Solana can click straight from any example into the canonical
  definition of unfamiliar terms without leaving the repo.

Rules followed
- First prose mention only; subsequent mentions stay plain.
- Code blocks, inline code, headers, and pre-existing markdown links untouched.
- Case-preserving link text ("Programs" stays "Programs", "PDA" stays "PDA").
- "instruction handler" and "mint account" link once; their constituents
  ("instruction", "mint") are linked at their next standalone prose mention.
- "program" is not linked inside compound proper nouns like "System Program",
  "Token Program", or "Classic Token Program" (would read oddly mid-name).

Anchor corrections vs the original spec
- program-derived address → #program-derived-address-pda  (spec said #program-derived-account)
- mint account / mint     → #token-mint                   (spec said #mint-account)
- associated token account → #associated-token-account-ata (spec said #associated-token-account)
- Token Extensions        → #token-extensions-program     (spec said #token-extensions)
- Classic Token Program   → #token-program                (the Solana terminology page uses
  the older shorter name "Token Program"; same concept — this is the classic SPL token
  program, as opposed to Token Extensions which has its own anchor).

Deliberately unlinked
- "signer" and "offchain" have no corresponding anchor on the Solana terminology
  page (it has #signature but not #signer; #onchain but not #offchain). Left
  unlinked rather than pointed at wrong/approximate targets.
@mikemaccana-edwardbot mikemaccana-edwardbot force-pushed the chore/readmes-link-solana-terminology branch from 5db6805 to 086d812 Compare May 14, 2026 22:24
@mikemaccana mikemaccana merged commit e95add4 into quicknode:main May 14, 2026
18 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants