[DOCS] all: clear the STYLE.md backlog on 42 pages - #54
Merged
Conversation
Every page that mentions onchain, offchain, an em dash, or a decorative check mark failed the prose linter. Because CI lints the files a pull request touches, that made any edit to those pages inherit an unrelated backlog, which is why recent content work had to route around them. - 222 onchain and offchain respellings, scripted with case preserved and fenced code skipped, so no sample changed. - 186 em dashes rewritten as a comma, period, colon, or parentheses. Paired dashes became parentheses or a comma pair rather than two sentence breaks. - 42 decorative check marks and arrows replaced with words, or dropped where the mark was only a bullet. - FHEOS to FheOS, Testnet to testnet, and four marketing or filler phrases. - Eight structure errors in the same files: duplicate manual H1s that Mintlify already renders from frontmatter, untagged output blocks, an absolute link to our own site, and two h1 to h3 heading jumps. No page in deep-dive is touched. The cofhejs tab is left alone as a frozen legacy reference. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
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.
Prose only. No code sample changed, and no page in
deep-diveis touched.This is the unblocking step before the 0.7 code sweep. Right now 81 of 113 pages fail the prose linter, and because
docs-stylelints the files a PR touches, editing any of them fails CI on a backlog that PR did not create. That is why #49 and #53 both had to route around pages they should have updated.What changed
on-chain/off-chaintoonchain/offchainFHEOStoFheOS,TestnettotestnetThe terminology and Unicode passes were scripted with fenced code blocks skipped, so no sample was modified. Case is preserved, so
On-chainbecameOnchain.Where the judgment went
Em dashes are not mechanical, and my first automated pass got some wrong. Two things I had to go back and fix:
Every confidential mutation — shield mint, confidential transfer, unshield burn — flows through itfirst became three fragments. It is nowEvery confidential mutation (shield mint, confidential transfer, unshield burn) flows through it. I found all 10 such lines by diffing againstmainfor lines that originally held two dashes, and checked each.- Yes Wallets to display "activity". Those lists now just drop the marker. Infhenix.mdxthe check marks were labelling problems (✅ Front-running & MEV), which was wrong to begin with; they are now plain bullets.Structure fixes were kept minimal and each is a STYLE.md rule: duplicate manual H1s (Mintlify renders the H1 from frontmatter), untagged console-output blocks tagged
text, an absolute link to our own site made root-relative, and two heading-level jumps. Onmigrating-from-cofhejs.mdxI initially promoted all 14###and flattened a real hierarchy; that is reverted, and only the three intro headings that preceded the first##were promoted.Result
valeandlint-docs.pyboth exit 0 on all 42 files.mint validateandmint broken-links --check-anchors --check-redirectspass. 383 warnings remain across these pages (heading case, sentence length), which do not fail the job and are not worth churning the diff for.After this lands, every page in the 0.7 code sweep can be edited without inheriting prose failures.
🤖 Generated with Claude Code