Add README and Documentation Style section#8
Open
mikemaccana wants to merge 1 commit into
Open
Conversation
![cursor[bot]](https://avatars.githubusercontent.com/in/1210556?s=60&v=4){kind=small}
This comment was marked as resolved.
This comment was marked as resolved.
Sorry, something went wrong.
mikemaccana-edwardbot
force-pushed
the
prose-readme-style
branch
3 times, most recently
from
c06e6b7 to
6facd6f
Compare
…p-level
Two changes:
1. Promote 'Terminology' from a Rust-Guidelines subsection to a
top-level section. The rules ('program' not 'protocol', onchain
spelling, instruction handler vs. instruction, no Ethereum
assumptions, token program names) are general Solana writing rules
that apply to TypeScript clients, Rust libraries, Anchor and Quasar
programs, README files, and any other prose - not just Rust. Moving
it out of the Rust subsection means agents working in TypeScript,
writing READMEs, or porting to Quasar see the same rules without
having to dig into a Rust-tagged section.
2. Add 'README and Documentation Style' section. Codifies the README
rules that came out of recent DeFi work: vocabulary discipline (one
name per concept, no SPL Token qualifier in prose, no token-mint
conflation, no securities mislabel), structure (no numbered headings,
word-based anchors, inline per-instruction reference into lifecycle
prose, no preview paragraphs), and prose hygiene (no em-dashes, no
ASCII art, no Mermaid, no tables, no ambiguous pronouns, no false
non-custodial claims, no TradFi-only framings).
The README section deliberately does not duplicate the Terminology
rules - those now live at the top level and apply to all prose by
default.
mikemaccana-edwardbot
force-pushed
the
prose-readme-style
branch
from
6facd6f to
19ba44a
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
1 participant
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.
Codify the README rules that came out of recent DeFi work (asset-leasing in particular). Covers vocabulary discipline (one name per concept, no protocol/on-chain/SPL Token/securities, no EVM analogies), structure (no numbered headings, no preview paragraphs, inline per-instruction reference into lifecycle prose), and prose hygiene (no em-dashes, no ASCII art, no Mermaid, no tables, no ambiguous pronouns, no false non-custodial claims).
These rules apply to README.md, design docs, doc comments, and any other prose that ships with the program.
Note
Low Risk
Documentation-only changes that don’t affect runtime behavior; risk is limited to potential reviewer disagreement on style guidelines.
Overview
Adds a new Terminology and Documentation Style section to
SKILL.md, codifying Solana-specific vocabulary, naming discipline, README/lifecycle documentation structure expectations, prose hygiene rules, and accuracy guidance for common claims.Removes the now-redundant Rust-only terminology subsection so these documentation standards apply consistently across TypeScript, Rust/Anchor, READMEs, and other project prose.
Reviewed by Cursor Bugbot for commit 19ba44a. Bugbot is set up for automated code reviews on this repo. Configure here.