Skip to content

docs: align Markdown tables for reading as plain text - #221

Merged
compot-dev merged 1 commit into
v2from
docs/align-tables
Oct 16, 2026
Merged

compot-dev merged 1 commit into
v2from
docs/align-tables

Conversation

@compot-dev

Copy link
Copy Markdown
Collaborator

Every table in README.md, README.ru.md, README.zh-CN.md and docs/{architecture,devices,security,testing,usage}.md is padded so its columns line up in a plain text editor: each column as wide as its widest cell (CJK characters count as two), one space around the text, separator rows filled with dashes, alignment colons kept.

Whitespace only. Cell contents, line count and the rendered result are unchanged (checked by re-parsing every row before and after).

docs/toys.md, docs/transports.md and docs/debug.md are changed by #215 and get the same treatment there, so this PR doesn't conflict with it.

@qodo-free-for-open-source-projects

Copy link
Copy Markdown

Code Review by Qodo

🐞 Bugs (0) 📘 Rule violations (0) 📎 Requirement gaps (0)

Grey Divider

Great, no issues found!

Qodo reviewed your code and found no material issues that require review

Grey Divider

Tip of the day
💡 Did you know, you can pick a display mode instead of tweaking every Display option by hand

More tips ↗ | Customize Qodo ↗ | Qodo docs ↗

Grey Divider

Qodo Logo

@compot-dev
compot-dev merged commit dbb252e into v2 Oct 16, 2026
2 checks passed
@qodo-free-for-open-source-projects

Copy link
Copy Markdown

PR Summary by Qodo

Align Markdown tables across READMEs and guides

📝 Documentation 🕐 10-20 Minutes

Grey Divider

AI Description

• Pad tables across three READMEs and five guides for easier plain-text reading.
• Align columns using display widths, including double-width CJK characters, without changing table
 content or rendering.
• Leave docs being changed in #215 untouched to avoid conflicts.
Diagram

graph TD
  Reader["Plain-text reader"] --> READMEs["Localized READMEs"] --> Guides["Five guides"]
Loading
High-Level Assessment

Direct whitespace-only formatting is appropriate for a bounded documentation cleanup. A persistent formatter would add maintenance overhead without changing the result; keeping files being edited in #215 out of scope also avoids a merge conflict.

Files changed (8) +201 / -201

Documentation (8) +201 / -201
README.mdAlign English README tables +22/-22

Align English README tables

• Pads the build, input-action, and documentation-index tables so columns align in plain text. Cell contents and links remain unchanged.

README.md

README.ru.mdAlign Russian README tables +21/-21

Align Russian README tables

• Aligns the build, input-action, and documentation-index tables using the display widths of their Russian text. The table content remains unchanged.

README.ru.md

README.zh-CN.mdAlign Chinese README tables +21/-21

Align Chinese README tables

• Pads the build, input-action, and documentation-index tables for plain-text alignment, accounting for CJK character widths. The table content remains unchanged.

README.zh-CN.md

architecture.mdAlign architecture reference tables +50/-50

Align architecture reference tables

• Pads the class-role, thread-work, and decode-planner rule tables. No architectural descriptions or rules are changed.

docs/architecture.md

devices.mdAlign device and decoder-note tables +42/-42

Align device and decoder-note tables

• Widens the verified-device table to fit its longest note and aligns the hardware-decoder notes table. Device reports and notes remain unchanged.

docs/devices.md

security.mdAlign security reference tables +10/-10

Align security reference tables

• Pads the log-redaction patterns and app-permissions tables. Security guidance and permission descriptions remain unchanged.

docs/security.md

testing.mdAlign testing and release tables +16/-16

Align testing and release tables

• Aligns tables covering branches, CI jobs, build outputs, and mapping files. Release and testing instructions remain unchanged.

docs/testing.md

usage.mdAlign menu and gesture tables +19/-19

Align menu and gesture tables

• Pads the menu-item and gesture reference tables for plain-text reading. Actions and links remain unchanged.

docs/usage.md

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