Skip to content

chore(rfc): wrap markdown at 120 columns and add RFC style rules to the rfc skill - #630

Merged
filvecchiato merged 1 commit into
mainfrom
chore/rfc-writing-flow
Sep 8, 2026
Merged

chore(rfc): wrap markdown at 120 columns and add RFC style rules to the rfc skill#630
filvecchiato merged 1 commit into
mainfrom
chore/rfc-writing-flow

Conversation

@johnthecat

@johnthecat johnthecat commented Sep 8, 2026

Copy link
Copy Markdown
Contributor

Tooling for writing and reviewing RFCs in this repo. Used to write the RFC stack #631#632#633#634, which ends in the Input Modality RFC.

Markdown formatting

.prettierrc wraps Markdown prose at 120 columns (proseWrap: always). Sentences in RFCs and design docs land on stable lines, so a review diff shows the sentence that changed rather than a rewrapped paragraph. Prettier is not part of CI; npm run format applies it and npm run format:check verifies it.

The rfc skill

The skill gains a Style section that turns the review rules for RFCs into something the skill applies while drafting:

  • Cut: selling text, enumerations of examples, em-dash appositions, bold-lead mini-sections, self-references, transition narrative, restated sections, unvalidated defaults and their placeholder variables, metaphors with their own vocabulary.
  • Shape: requirements as constraints on any acceptable design; one bullet is one rule; a design roadmap is a bullet list introduced by "The design has N parts:"; tables carry a one-line caption; Rust blocks are complete traits in the shape of rust/crates/truapi/src/api/*.rs; a shared concept is defined in one RFC and linked from the others; inline lists are examples unless declared exhaustive.
  • Process: read the whole document first, trim in reading order, earlier text wins, fix invalidated terms in the same pass, verify no dangling references, and leave whole-section deletion to the author.

The mechanics section is reflowed to the new column width; its content is unchanged.

@johnthecat
johnthecat requested a review from a team September 8, 2026 10:12
@johnthecat johnthecat self-assigned this Sep 8, 2026
@TarikGul

TarikGul commented Sep 8, 2026

Copy link
Copy Markdown
Member

Good to have @filvecchiato review this.

@filvecchiato
filvecchiato added this pull request to the merge queue Sep 8, 2026
Merged via the queue into main with commit d712a8b Sep 8, 2026
19 checks passed
@filvecchiato
filvecchiato deleted the chore/rfc-writing-flow branch September 8, 2026 11:34
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.

3 participants