Reformat Markdown with mdtablefix (mdformat-all) - #377
Merged
Conversation
Run the in-house Markdown formatter `mdformat-all`, which applies `mdtablefix --wrap --renumber --breaks --ellipsis --fences --in-place` followed by `markdownlint-cli2 --fix` across all Markdown files. This is the raw formatter output, committed as a reviewable baseline before correcting any changes the reflow made incorrectly. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
![sourcery-ai[bot]](https://avatars.githubusercontent.com/in/48477?s=60&v=4){kind=small}
There was a problem hiding this comment.
Sorry @LodyAI[bot], your pull request is larger than the review limit of 500000 diff characters
Contributor
|
Note Reviews pausedIt looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the Use the following commands to manage reviews:
Use the checkboxes below for quick actions:
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: ASSERTIVE Plan: Pro Plus Run ID: 📒 Files selected for processing (93)
👮 Files not reviewed due to content moderation or server errors (93)
Markdown formatting standardisation across repositoryThis pull request reformats 93 markdown files across the repository using the in-house Changes madeFile categories reformatted:
Formatting adjustments made: Defects corrected during reflowThree specific markdown-formatter defects were identified and corrected:
Verification
WalkthroughReflowed Markdown and adjusted line wrapping across many docs: AGENTS guidance, README, execplans, roadmaps, architecture, guides and user docs. Added a few clarifying CI/testing notes; no code or public API changes. ChangesDocumentation refresh
Sequence Diagram(s)Skipped. Possibly related PRs
Poem
✨ Finishing Touches🧪 Generate unit tests (beta)
|
![codescene-delta-analysis[bot]](https://avatars.githubusercontent.com/in/53921?s=60&v=4){kind=small}
This comment was marked as outdated.
This comment was marked as outdated.
Sorry, something went wrong.
The raw `mdformat-all` output introduced two classes of defect, both
addressed here so the documentation again passes `make markdownlint`.
1. Code corruption from `--ellipsis`. The formatter rewrote literal `...`
to the Unicode ellipsis `…` inside *indented* (four-space) code blocks,
which it does not protect (unlike fenced and inline code). This altered
example content in two files:
- backend-2-3-3-pwa-contract-tests.md: sample `cargo test` output.
- backend-2-4-3-example-data-runs-migration.md: a `define_port_error!`
Rust snippet's string literals.
Restored the ASCII `...` in both.
2. MD013 line-length regressions (15 lines). The `--wrap` pass left some
inline-code spans on a single line longer than 80 columns, because it
will not break inside inline code. Rather than hand-wrap the spans, the
formatter's output is kept verbatim and an inline
`<!-- markdownlint-disable-line MD013 -->` directive suppresses the rule
on each affected line; the comment sits outside the code span and renders
as nothing.
Fenced code blocks (including all Mermaid diagrams) are byte-identical to
the pre-reformat sources, so `make nixie` is unaffected.
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
lodyai
Bot
force-pushed
the
docs/mdtablefix-reformat
branch
from
June 9, 2026 18:34
2572e33 to
280b7ca
Compare
This comment was marked as outdated.
This comment was marked as outdated.
Sorry, something went wrong.
leynos
marked this pull request as ready for review
June 9, 2026 23:26
There was a problem hiding this comment.
Sorry @leynos, your pull request is larger than the review limit of 500000 diff characters
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 280b7ca58e
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Two further defects from the raw mdtablefix reflow, both caught in review: 1. Footnote reference turned into a definition. In `building-accessible-and-responsive-progressive-web-applications.md`, the reflow pushed the `[^96]` reference in "subcategories [^96]:" to column 1, where `[^96]:` parses as a footnote *definition*. The duplicate definition was then dropped along with the real `[^96]: Reference 96 ...` text, whose orphaned continuation line was absorbed into the `[^95]` definition. Restored the inline reference, re-added the `[^96]` definition, and removed the stray duplicate continuation line under `[^95]`. 2. Stray trailing pipe in a shell snippet. In `backend-phase-1-enforce-configuration-toggles.md`, a code-block line beginning with `|` was treated as a table row and "balanced" with a trailing `|`, leaving an unterminated pipeline (`| tee /tmp/wildside-test.log |`) that fails when copied. Removed the trailing pipe. A repository-wide sweep confirms these are the only instances of either class: all footnote definition sets are otherwise preserved, and no other code-block line gained a trailing pipe. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Owner
|
@coderabbitai review |
Contributor
✅ Action performedReview finished.
|
Contributor
✅ Action performedReview finished.
|
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.
Summary
Runs the in-house Markdown formatter
mdformat-allacross the repository andaddresses the defects its reflow introduced, so the docs again pass
make markdownlint.mdformat-allapplies:over every
.md/.markdown/.mdxfile (93 files changed in the raw pass).Commits
as a reviewable baseline.
MD013 suppressions (below).
in review (below).
Defects found in the raw reflow
Before the reformat
make markdownlintreported 0 errors. Each defectbelow is filed upstream against
leynos/mdtablefix.1. Code corruption from
--ellipsis(semantic break) — mdtablefix#369Rewrites literal
...to…; protects fenced and inline code but notindented (four-space) code blocks. Corrupted sample
cargo testoutput(
backend-2-3-3-pwa-contract-tests.md) and adefine_port_error!Rust snippet(
backend-2-4-3-example-data-runs-migration.md). Restored ASCII....2. MD013 line-length regressions (15 lines) — mdtablefix#370
--wrapleft some inline-code spans on a single line over 80 columns. Theformatter output is kept verbatim and an inline
<!-- markdownlint-disable-line MD013 -->directive suppresses the rule on eachaffected line (the comment sits outside the code span and renders as nothing).
3. Footnote reference turned into a definition (semantic break) — mdtablefix#372
In
building-accessible-and-responsive-progressive-web-applications.md, thereflow pushed the
[^96]reference in "subcategories [^96]:" to column 1,where
[^96]:parses as a footnote definition. The duplicate definition wasthen dropped together with the real
[^96]: Reference 96 ...text, whoseorphaned continuation line was absorbed into the
[^95]definition. Restoredthe inline reference, re-added the
[^96]definition, and removed the strayduplicate continuation under
[^95]. markdownlint does not flag undefinedfootnotes, so this would have shipped silently.
4. Stray trailing pipe in a shell snippet (semantic break) — mdtablefix#373
In
backend-phase-1-enforce-configuration-toggles.md, a code-block linebeginning with
|was treated as a table row and "balanced" with a trailing|, leaving an unterminated pipeline (| tee /tmp/wildside-test.log |) thatfails when copied. Removed the trailing pipe.
A repository-wide sweep confirms defects 3 and 4 each have exactly one
instance: all other footnote definition sets are preserved and no other
code-block line gained a trailing pipe.
What was verified as correct (house style, not breakage)
93 files — including every Mermaid diagram.
changes are re-alignment only.
Verification
make markdownlint→ 0 errors (119 files).make fmtis unrelated to Markdown (Rust + Biome only) and is a no-op here.🤖 Generated with Claude Code