Skip to content

docs: apply mdformat house-style reflow - #103

Merged
leynos merged 2 commits into
mainfrom
docs/mdformat-reflow
Jun 9, 2026
Merged

docs: apply mdformat house-style reflow#103
leynos merged 2 commits into
mainfrom
docs/mdformat-reflow

Conversation

@lodyai

@lodyai lodyai Bot commented Jun 9, 2026

Copy link
Copy Markdown
Contributor

Summary

Ran make fmt across all Markdown sources to bring them into line with the project's house style. The target runs cargo fmt, mdtablefix, and markdownlint-cli2 --fix.

40 Markdown files changed (283 insertions, 313 deletions). Every change is cosmetic:

  • Line rewrapping to the house wrap width.
  • Table column realignment (docs/gauss-keyboard-shortcuts.md, docs/rust-testing-with-rstest-fixtures.md).
  • Minor structural reflow of repeated boilerplate (e.g. the "living document" ExecPlan preamble).

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:

Case File Verdict
Full reference link split across a newline inside the label — [1][\nillustrator-6], ([1][\nsymbol-sprayer]) docs/gauss-feature-plan.md Valid — renders as a link under CommonMark (whitespace in link labels is normalised).
Footnote references on adjacent wrapped lines — needed.[^undo2-docs] / [^undo2-versions] docs/adr-002-undo-history-crate-selection.md Valid — same paragraph, both resolve as footnote references (no colon, so not mistaken for definitions).

These 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 markdownlint0 errors across 70 files.

🤖 Generated with Claude Code

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>

@sourcery-ai sourcery-ai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry @LodyAI[bot], you have reached your weekly rate limit of 2500000 diff characters.

Please try again later or upgrade to continue using Sourcery

codescene-delta-analysis[bot]

This comment was marked as outdated.

@coderabbitai

coderabbitai Bot commented Jun 9, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

Note

Reviews paused

It 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 reviews.auto_review.auto_pause_after_reviewed_commits setting.

Use the following commands to manage reviews:

  • @coderabbitai resume to resume automatic reviews.
  • @coderabbitai review to trigger a single review.

Use the checkboxes below for quick actions:

  • ▶️ Resume reviews
  • 🔍 Trigger review

Walkthrough

This 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.

Changes

AccessKit accessibility implementation and documentation standardisation

Layer / File(s) Summary
AccessKit accessibility expansion
docs/accesskit-based-accessibility-in-gpui.md
Expands proposal with platform-specific tooling descriptions, refined acceptance criteria for Windows UIA/NVDA/JAWS/Narrator and macOS VoiceOver/Linux AT-SPI, explicit keyboard mapping for Gauss canvas interactions, macOS implementation guidance for switch/voice control (accessibilityPerformPress), Windows custom windowing integration notes (WM_GETOBJECT, provider readiness, focus-state updates), stable NodeId architecture tying to GPUI Entity lifetimes, rich-text limitation risks, and expanded dependency/reference section with WCAG/EN 301 549/Section 508 mappings and VPAT preparation guidance.
Execution plan boilerplate standardisation
docs/execplans/*.md, docs/execplans/adr-*.md, docs/execplans/build-time-*.md, docs/execplans/issue-*.md
Standardises opening "living document" constraints across 24 execution plans by reformatting line-wrapping and rendering section names (Constraints, Tolerances, Risks, Progress, Surprises & Discoveries, Decision Log, Outcomes & Retrospective) consistently with inline code styling.
General documentation formatting
AGENTS.md, docs/adr-*.md, docs/complexity-*.md, docs/gauss-*.md, docs/reliable-*.md, docs/rstest-*.md, docs/rust-*.md, docs/widget-*.md
Adjusts markdown line-wrapping and formatting in dependency guidance, architectural design notes, feature planning, keyboard shortcuts table, testing guides, and widget audit documentation. Includes minor wording adjustments (e.g., "filesystem" addition in dependency-injection guide, Phase 1 SVG capability clarification in feature plan, table alignment in keyboard shortcuts).

Possibly related issues

Possibly related PRs

Poem

📝 Lines flow and wrap with newfound grace,
As AccessKit finds its proper place,
From widgets bright to trees of state,
Each format clean, each doc first-rate! ✨

🚥 Pre-merge checks | ✅ 20
✅ Passed checks (20 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly summarises the main change: applying mdformat house-style reflow to Markdown documentation files, directly matching the PR's primary objective.
Description check ✅ Passed The description is directly related to the changeset, explaining the purpose (running make fmt to apply house style), scope (40 Markdown files), and nature (cosmetic/line-wrapping only) of the changes.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Testing (Overall) ✅ Passed PR introduces no new functionality or behavioural changes—purely documentation formatting (Markdown line-wrapping, table alignment). Testing check does not apply.
User-Facing Documentation ✅ Passed PR contains exclusively documentation formatting changes (40 Markdown files) with zero code modifications. No new user-facing functionality or behaviour introduced; no users-guide.md update required.
Developer Documentation ✅ Passed PR is purely formatting (mdformat house style); no new APIs, architectural changes, decisions, or roadmap updates—custom check requirements for substantive documentation changes do not apply.
Module-Level Documentation ✅ Passed PR modifies only Markdown documentation files (40 files, formatting/reflow only). No code modules were added or changed, so the module-level docstring check does not apply.
Testing (Unit And Behavioural) ✅ Passed PR is documentation-only (40 Markdown files); no code changes present. Testing check is not applicable to pure documentation formatting changes.
Testing (Property / Proof) ✅ Passed PR is documentation-only (40 .md files with formatting reflow). No code changes, invariants, algorithms, lemmas, or proofs introduced; property-testing/formal-verification check not applicable.
Testing (Compile-Time / Ui) ✅ Passed PR is documentation-only (40 markdown files, cosmetic formatting only); no code or behavioural changes. Custom check for compile-time/UI tests is not applicable.
Unit Architecture ✅ Passed PR is documentation-only (40 Markdown files reformatted via mdformat); Unit Architecture check applies only to code changes. No code units, dependencies, or architectural boundaries are affected.
Domain Architecture ✅ Passed Custom check for domain architecture is not applicable to this PR, which contains only Markdown documentation reformatting (40 files, no code changes).
Observability ✅ Passed PR modifies only Markdown documentation formatting via mdformat house-style reflow. No operational behaviour, code logic, or exported entities are altered—observability check not applicable.
Security And Privacy ✅ Passed No hardcoded secrets, credentials, or sensitive data exposed. Token references use GitHub's encrypted secrets mechanism, not plaintext values. No security or privacy concerns detected.
Performance And Resource Use ✅ Passed PR contains only Markdown documentation formatting (40 files); no code changes, algorithms, or resource-use modifications. Performance check not applicable to cosmetic documentation reflow.
Concurrency And State ✅ Passed PR contains only Markdown formatting changes (line wrapping, table alignment) across 40 documentation files; no code changes, concurrency model changes, or state management modifications present.
Architectural Complexity And Maintainability ✅ Passed PR applies only mdformat house-style reflow to 40+ existing markdown files with zero architectural changes, no new code, abstractions, layers, or dependencies introduced.
Rust Compiler Lint Integrity ✅ Passed PR contains only Markdown documentation changes; the Rust compiler lint integrity check applies exclusively to Rust source files, which this PR does not modify.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/mdformat-reflow

Comment @coderabbitai help to get the list of available commands and usage tips.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

📥 Commits

Reviewing files that changed from the base of the PR and between 1bcb028 and 730feb3.

📒 Files selected for processing (40)
  • AGENTS.md
  • docs/accesskit-based-accessibility-in-gpui.md
  • docs/adr-002-undo-history-crate-selection.md
  • docs/adr-003-slotmap-shapeid-accesskit-id-mapping.md
  • docs/complexity-antipatterns-and-refactoring-strategies.md
  • docs/execplans/0-2-2-stable-id-generation.md
  • docs/execplans/0-2-3-define-resource-stores.md
  • docs/execplans/0-3-1-audit-undo-redo-implementation.md
  • docs/execplans/0-3-2-command-grouping-api.md
  • docs/execplans/0-3-4-state-engine-ownership-of-history.md
  • docs/execplans/0-3-5-evolve-history-error-model-to-enum.md
  • docs/execplans/0-4-1-define-metadata-namespace.md
  • docs/execplans/0-4-2-metadata-round-trip.md
  • docs/execplans/0-4-3-web-ready-export.md
  • docs/execplans/0-5-1-tool-trait.md
  • docs/execplans/0-5-2-refactor-draw-mode-to-use-tool-trait.md
  • docs/execplans/0-5-3-refactor-manipulate-mode-to-tool-trait.md
  • docs/execplans/0-5-4-shared-hit-test-service.md
  • docs/execplans/0-6-1-create-a11y-service-structure.md
  • docs/execplans/0-6-2-wire-existing-stable-node-ids.md
  • docs/execplans/0-6-3-map-access-kit-action-requests-to-gauss-actions.md
  • docs/execplans/0-7-1-i18n-module.md
  • docs/execplans/0-7-2-extract-ui-strings.md
  • docs/execplans/0-8-1-list-required-controls-for-phase-1-2.md
  • docs/execplans/adr-002-undo-2-spike.md
  • docs/execplans/build-time-audit-gpui-feature-selection.md
  • docs/execplans/build-time-consolidate-integration-test-targets.md
  • docs/execplans/build-time-move-model-and-svg-tests.md
  • docs/execplans/build-time-trim-dev-debuginfo-for-dependencies.md
  • docs/execplans/build-time-workspace-crate-split.md
  • docs/execplans/issue-18-add-command-variants.md
  • docs/gauss-architecture-design.md
  • docs/gauss-feature-plan.md
  • docs/gauss-keyboard-shortcuts.md
  • docs/reliable-testing-in-rust-via-dependency-injection.md
  • docs/rstest-bdd-users-guide.md
  • docs/rust-doctest-dry-guide.md
  • docs/rust-testing-with-rstest-fixtures.md
  • docs/widget-audit-developer-guide.md
  • docs/widget-capability-audit.md

Comment thread docs/accesskit-based-accessibility-in-gpui.md Outdated
Comment thread docs/gauss-feature-plan.md Outdated
Comment thread docs/rstest-bdd-users-guide.md
Comment thread docs/rstest-bdd-users-guide.md Outdated
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>
@lodyai

lodyai Bot commented Jun 9, 2026

Copy link
Copy Markdown
Contributor Author

Note on the local nixie (Mermaid) gate

The repo-wide make nixie gate can intermittently fail on this shared, multi-agent machine with diagram … timed out errors. This is environmental flakiness, not a fault in this PR:

  • All Mermaid diagram blocks are byte-identical to origin/main — this reflow changed zero diagram content (verified by diffing every fenced ```mermaid block).
  • Each diagram renders fine in ~10s in isolation (valid SVG), but nixie runs ~5 Chromium instances concurrently (default cpu-1); under concurrent load from other agents, individual renders exceed nixie's hardcoded 30s per-diagram timeout.
  • A full make markdownlint nixie run on these exact commits passed cleanly (exit 0, 0 timeouts) during a quieter moment.
  • The diagrams that time out vary run-to-run (e.g. documentation-style-guide.md, rstest-bdd-*), including files this PR does not modify — confirming it is load-induced, not content-induced.

markdownlint passes (0 errors) on every run. No diagram or build-tooling changes are warranted for this docs-only PR.

@leynos
leynos merged commit 7f50d0a into main Jun 9, 2026
5 checks passed
@leynos
leynos deleted the docs/mdformat-reflow branch June 9, 2026 23:26
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.

1 participant