Skip to content

docs: restyle the README and add the repository logo - #329

Merged
humuhumu33 merged 1 commit into
mainfrom
docs/readme-refresh
Oct 27, 2026
Merged

humuhumu33 merged 1 commit into
mainfrom
docs/readme-refresh

Conversation

@humuhumu33

Copy link
Copy Markdown
Contributor

Rewrites README.md for a reader arriving cold, in the shape other projects use: a centered header (logo, one-line value proposition, document links, state badges), then Quickstart (container, binary, source, the SPEC.md §29 literal), How LexLean works (pipeline plus a command table whose third column says what each command may claim), Why LexLean, When to use LexLean, the capability register table, the examples, the gate, the evidence rules, the documented deviations, the layout and the license.

Gate-relevant content is unchanged. The capability table keeps its exact header line, its three cells, its build level cell and its 35 rows, so every one of the 457 registered IDs is still claimed exactly once, ranges still start and end at the register's first and last ID for their prefix, and the register-size sentence (All 457 registered conformance IDs) and the honesty-level phrase remain as RP-11 reads them.

No hyphen is used as punctuation anywhere in the prose and no list uses a hyphen marker; hyphens remain only inside identifiers, paths, commands, code spans and table separator rows, because those tokens are machine-checked (RP-11 parses RP-01..RP-18) and appear in links.

assets/lexlean-logo.svg is new: a QED tombstone with a check mark beside a monospace wordmark, in the repository's purple, legible on both light and dark renderings. SPEC.md §7 gains the two tree rows that give the file the defined role §7 requires; RP-03's §7 parse asserts that every listed path exists, and it does.

Verified locally against the gate's own logic, re-implemented from conformance_rp_11 and conformance_rp_03: 35 capability rows, 457 claimed IDs, no duplicate and no unclaimed ID, no range that leaves its prefix or misses the register's first or last ID, 231 §7 tree rows present on disk, no assertive vocabulary on any line naming an authority, no em or en dash. just vv itself is the gate's to run.

The README is reorganized for a reader arriving cold: a centered header
with the logo, the one-line value proposition, the document links and the
state badges, then Quickstart (container, binary, source, the §29 literal),
How LexLean works (pipeline plus the command table with what each command
may claim), Why LexLean, When to use LexLean, the capability register
table, the examples, the gate, the evidence rules, the documented
deviations, the layout and the license.

The gate-relevant content is unchanged: the capability table keeps its
exact header, its three cells, its `build` level cell and its 35 rows, so
every one of the 457 registered IDs is still claimed exactly once by the
row that owns it, and the register-size and honesty-level sentences are
still stated.

No dash is used as punctuation anywhere in the prose, and no list uses a
hyphen marker; hyphens remain only where they are part of an identifier, a
path, a command or a table separator, because those are machine-checked
tokens.

assets/lexlean-logo.svg is new: a QED tombstone with a check mark beside a
monospace wordmark, in the repository's own purple, legible on light and
dark renderings. SPEC.md §7 lists it, so the added file has the defined
role §7 requires.

afflom commented Oct 27, 2026

Copy link
Copy Markdown
Member

Thanks; the shape is right and the gate-relevant invariants you list are the ones RP-11 and RP-03 read. Two things before it can land:

  1. Target release/v0.4, not main. Since the release-lines rule (SPEC.md §9.4, 2026-10-20) main receives a line only at its tag; every pull request lands on a line and reaches main with the next tag. This is a 0.4.x change, so rebase or merge onto release/v0.4 and retarget the PR there. On that line the register is 458 (H6 landed after the tag; H7 lands next and adds no row), so the register-size sentence reads All 458 registered conformance IDs and the capability table carries the 458 IDs of the line's model/ids.toml (the one new row since 457 is SP-30, in the preservation range). RP-11 recounts from the register, so the numbers must be the line's.

  2. The §7 rows and the forward merge. SPEC.md is hand-edited on release/v0.4, so the two §7 tree rows are fine as written; on release/v0.5 SPEC.md is a projection of spec/src, and I port the rows into Chapter07 with cargo xtask spec port at the next forward merge, as I did for H5 and H6. Nothing for you to do there.

It queues after #305 (H7-audit, in landing) and #247; I land it with the usual regeneration if the gate needs one (a README and an SVG move no identity, so likely none). Mark it ready again once it sits on release/v0.4 with the 458 counts.


Generated by Claude Code

@humuhumu33
humuhumu33 merged commit b884aa8 into main Oct 27, 2026
28 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