docs: apply mdformat house-style reflow - #103
Conversation
Run `make fmt` across all Markdown sources. Changes are limited to line rewrapping and table column realignment to match the project's house style; no prose content changed. Verified: markdownlint reports 0 errors. Reference-style links that the reflow split across a line break (gauss-feature-plan.md) and footnote references on adjacent lines (adr-002) were confirmed to still resolve correctly under CommonMark. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
|
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:
WalkthroughThis PR standardises documentation formatting across the repository through systematic markdown line-wrapping adjustments. The primary substantive change expands AccessKit-based accessibility guidance with clarified implementation details, platform-specific acceptance criteria for Windows/macOS/Linux, architectural notes on stable node IDs, and mitigations for rich-text limitations. Remaining changes standardise execution plan boilerplate and general documentation formatting. ChangesAccessKit accessibility implementation and documentation standardisation
Possibly related issues
Possibly related PRs
Poem
🚥 Pre-merge checks | ✅ 20✅ Passed checks (20 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
There was a problem hiding this comment.
Actionable comments posted: 4
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@docs/accesskit-based-accessibility-in-gpui.md`:
- Line 94: Replace the US spelling "behavior" with the en-GB-oxendict spelling
"behaviour" in the prose fragment that currently reads "for expected behavior.)"
so the document conforms to docs/** style; search for the exact string "for
expected behavior.)" and update it to "for expected behaviour.)".
In `@docs/gauss-feature-plan.md`:
- Around line 78-80: Replace first-person phrasing in the two identified
sentences: change "In this phase, SVG is sufficient to represent the basic
shapes, groups, and style properties we have. (In later phases, we will evaluate
if SVG can still capture all advanced features or if an alternative open format
is needed.)" to an impersonal form such as "In this phase, SVG is sufficient to
represent the basic shapes, groups, and current style properties. (In later
phases, the plan will evaluate whether SVG can still capture all advanced
features or if an alternative open format is needed.)" and change "We prioritize
them here to position Gauss as a serious creative tool." to an impersonal
phrasing like "They are prioritized here to position Gauss as a serious creative
tool." Ensure no first- or second-person pronouns remain in those sentences.
In `@docs/rstest-bdd-users-guide.md`:
- Around line 1680-1681: Edit the sentence that reads "Each skipped scenario
emits a `<skipped>` element with an optional `message` attribute so continuous
integration (CI) servers surface the reason:" and insert a comma before the
clause starting with "so" so it becomes "...`message` attribute, so continuous
integration (CI) servers surface the reason:"; update the text in the
docs/rstest-bdd-users-guide.md content matching that exact phrase.
- Around line 833-835: The sentence describing `ScenarioStatus` and the macros
that accept `message_absent = true` is missing a comma: update the sentence that
currently reads "`message_absent = true` to assert that no message was provided
and substring matching to confirm...`" by inserting a comma after "provided" so
it reads "...to assert that no message was provided, and substring matching..."
to separate the two independent clauses; this change affects the line where
`ScenarioStatus` and `message_absent = true` are documented.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: ASSERTIVE
Plan: Pro Plus
Run ID: d10d5600-32ad-40ac-b364-0fa445750956
📒 Files selected for processing (40)
AGENTS.mddocs/accesskit-based-accessibility-in-gpui.mddocs/adr-002-undo-history-crate-selection.mddocs/adr-003-slotmap-shapeid-accesskit-id-mapping.mddocs/complexity-antipatterns-and-refactoring-strategies.mddocs/execplans/0-2-2-stable-id-generation.mddocs/execplans/0-2-3-define-resource-stores.mddocs/execplans/0-3-1-audit-undo-redo-implementation.mddocs/execplans/0-3-2-command-grouping-api.mddocs/execplans/0-3-4-state-engine-ownership-of-history.mddocs/execplans/0-3-5-evolve-history-error-model-to-enum.mddocs/execplans/0-4-1-define-metadata-namespace.mddocs/execplans/0-4-2-metadata-round-trip.mddocs/execplans/0-4-3-web-ready-export.mddocs/execplans/0-5-1-tool-trait.mddocs/execplans/0-5-2-refactor-draw-mode-to-use-tool-trait.mddocs/execplans/0-5-3-refactor-manipulate-mode-to-tool-trait.mddocs/execplans/0-5-4-shared-hit-test-service.mddocs/execplans/0-6-1-create-a11y-service-structure.mddocs/execplans/0-6-2-wire-existing-stable-node-ids.mddocs/execplans/0-6-3-map-access-kit-action-requests-to-gauss-actions.mddocs/execplans/0-7-1-i18n-module.mddocs/execplans/0-7-2-extract-ui-strings.mddocs/execplans/0-8-1-list-required-controls-for-phase-1-2.mddocs/execplans/adr-002-undo-2-spike.mddocs/execplans/build-time-audit-gpui-feature-selection.mddocs/execplans/build-time-consolidate-integration-test-targets.mddocs/execplans/build-time-move-model-and-svg-tests.mddocs/execplans/build-time-trim-dev-debuginfo-for-dependencies.mddocs/execplans/build-time-workspace-crate-split.mddocs/execplans/issue-18-add-command-variants.mddocs/gauss-architecture-design.mddocs/gauss-feature-plan.mddocs/gauss-keyboard-shortcuts.mddocs/reliable-testing-in-rust-via-dependency-injection.mddocs/rstest-bdd-users-guide.mddocs/rust-doctest-dry-guide.mddocs/rust-testing-with-rstest-fixtures.mddocs/widget-audit-developer-guide.mddocs/widget-capability-audit.md
Apply four reviewer-requested corrections to documents touched by the reflow: - accesskit-based-accessibility-in-gpui.md: en-GB "behaviour" spelling. - gauss-feature-plan.md: replace first-person voice with impersonal phrasing in two sentences. - rstest-bdd-users-guide.md: add a comma before two "so"/"and" clauses joining independent clauses. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Note on the local
|
Summary
Ran
make fmtacross all Markdown sources to bring them into line with the project's house style. The target runscargo fmt,mdtablefix, andmarkdownlint-cli2 --fix.40 Markdown files changed (283 insertions, 313 deletions). Every change is cosmetic:
docs/gauss-keyboard-shortcuts.md,docs/rust-testing-with-rstest-fixtures.md).No prose content was altered.
Review of the reformat
The brief was to flag any file where the formatter semantically broke the Markdown or introduced a markdownlint violation — as opposed to merely applying house style.
Finding: none. All 40 changes are pure house-style reflow.
The only borderline cases were checked explicitly:
[1][\nillustrator-6],([1][\nsymbol-sprayer])docs/gauss-feature-plan.mdneeded.[^undo2-docs]/[^undo2-versions]docs/adr-002-undo-history-crate-selection.mdThese were verified by rendering through a CommonMark engine (
markdown-it-py), confirming each split link still resolves to its definition.Verification
make fmt— clean run.make markdownlint— 0 errors across 70 files.🤖 Generated with Claude Code