Skip to content

docs: FAQ sections, searchable finance README titles, and llms.txt#110

Open
mikemaccana wants to merge 2 commits into
mainfrom
claude/solana-examples-discoverability-wo9rd9
Open

docs: FAQ sections, searchable finance README titles, and llms.txt#110
mikemaccana wants to merge 2 commits into
mainfrom
claude/solana-examples-discoverability-wo9rd9

Conversation

@mikemaccana

Copy link
Copy Markdown
Collaborator

Repo-side discoverability pass, aimed at owning "Solana finance" searches and being the source AI answer engines cite.

What changed

Finance example READMEs (19 files)

  • Every finance README (anchor, quasar, and native variants) now titles itself # Solana <Example> (<Framework>), e.g. # Solana Escrow (Anchor). Each example directory is its own indexable page, so the title now names the example the way someone searches for it.
  • Openers rewritten definition-first where needed: the first sentence says what the program is, names Solana, and stands alone when quoted out of context.
  • The 9 anchor/ READMEs gain FAQ sections written as the questions people actually ask ("How does a lending protocol work on Solana?"), each answered in a few self-contained sentences naming the real instruction handlers. FAQs live only in the anchor variants to avoid duplicate content across frameworks.

Root README

  • General FAQ (6 questions: programs vs smart contracts, LiteSVM testing, framework comparison, learning path, production-readiness).
  • Explicit toolchain-currency line (Anchor 1.1, LiteSVM, July 2026) pointing at CHANGELOG.md.
  • Remaining em-dashes removed.

New files

  • llms.txt: summary and link manifest of the finance examples for LLM crawlers and answer engines.
  • docs/example-readme-template.md: the template CONTRIBUTING.md referenced but which did not exist. Records the H1 convention and definition-first opener.

Housekeeping

  • CONTRIBUTING.md style rules gain the H1 naming convention and the no-em-dash rule.
  • CHANGELOG.md entry for the pass.
  • Cleaned all em-dashes from the prop-amm README and one pre-existing "on-chain" in betting-market/quasar.

Verification

  • Docs-only: no program code touched.
  • pnpm run check (biome) passes on all 122 files.
  • Every instruction handler named in new FAQ prose was verified against the program source (make_offer, check_contributions, liquidate_obligation, etc.).
  • Swept changed files for em-dashes, history-speak, hyphenated "on-chain", and multiple H1s.

🤖 Generated with Claude Code

https://claude.ai/code/session_01Hg7BMuBfsTrVmBQgGE63NB


Generated by Claude Code

claude added 2 commits July 11, 2026 19:31
Each finance example directory is its own indexable page, so every
finance README now titles itself 'Solana <Example> (<Framework>)' and
opens with a self-contained definition. The anchor variants gain FAQ
sections written as the questions people actually ask, answering with
the real instruction handler names. The root README gains a general
FAQ, an explicit toolchain-currency line, and loses its em-dashes.
llms.txt gives LLM crawlers and answer engines a summary and link
manifest for the finance examples. docs/example-readme-template.md is
the template CONTRIBUTING.md already referenced but which did not
exist; it records the H1 convention and definition-first opener.
CONTRIBUTING.md style rules gain the H1 naming convention and the
no-em-dash rule.
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