docs: FAQ sections, searchable finance README titles, and llms.txt#110
Open
mikemaccana wants to merge 2 commits into
Open
docs: FAQ sections, searchable finance README titles, and llms.txt#110mikemaccana wants to merge 2 commits into
mikemaccana wants to merge 2 commits into
Conversation
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.
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
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.
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)
# 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.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
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
Verification
pnpm run check(biome) passes on all 122 files.make_offer,check_contributions,liquidate_obligation, etc.).🤖 Generated with Claude Code
https://claude.ai/code/session_01Hg7BMuBfsTrVmBQgGE63NB
Generated by Claude Code