Skip to content

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

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

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

Conversation

@compot-dev

Copy link
Copy Markdown
Collaborator

Every table in README.md, README.ru.md, README.zh-CN.md, bench/README.md, bench/vectors/README.md, docs/architecture.md, docs/protocol.md, docs/testing.md, docs/usage.md, server/README.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).

Columns padded to the widest cell (CJK characters count as two), one space around the text, separator rows filled with dashes, alignment colons kept. Whitespace only.
@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

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

Copy link
Copy Markdown

PR Summary by Qodo

Align Markdown tables for plain-text readability

📝 Documentation 🕐 10-20 Minutes

Grey Divider

AI Description

• Align tables across ten documentation files so columns are readable in plain-text editors.
• Preserve cell contents, row counts, alignment markers, and rendered Markdown.
Diagram

graph TD
  Root["Root READMEs"] --> Tables["Aligned tables"] --> Plain["Plain-text reading"]
  Bench["Bench guides"] --> Tables --> Render["Rendered Markdown"]
  Technical["Technical guides"] --> Tables
  Server["Server guide"] --> Tables
Loading
High-Level Assessment

Direct whitespace-only formatting is appropriate for this documentation change. A persistent formatter or table rewrite would add maintenance scope without improving the unchanged rendered content.

Files changed (10) +216 / -216

Documentation (10) +216 / -216
README.mdAlign English project-guide tables +26/-26

Align English project-guide tables

• Pads the platform, documentation index, and roadmap tables for plain-text column alignment. Cell contents remain unchanged.

README.md

README.ru.mdAlign Russian project-guide tables +27/-27

Align Russian project-guide tables

• Pads the platform, documentation index, and roadmap tables while accounting for the displayed width of their contents.

README.ru.md

README.zh-CN.mdAlign Chinese project-guide tables +27/-27

Align Chinese project-guide tables

• Pads the platform, documentation index, and roadmap tables for plain-text alignment, including double-width CJK characters.

README.zh-CN.md

README.mdAlign test-bench session table +9/-9

Align test-bench session table

• Pads the session, purpose, and flags columns without changing the documented sessions.

bench/README.md

README.mdAlign handshake reference table +6/-6

Align handshake reference table

• Pads the direction and message columns while preserving the reference-vector text.

bench/vectors/README.md

architecture.mdAlign architecture reference tables +25/-25

Align architecture reference tables

• Pads the repository-layout and lwIP-versus-TAP comparison tables for easier plain-text scanning.

docs/architecture.md

protocol.mdAlign VTun protocol tables +18/-18

Align VTun protocol tables

• Pads the challenge-response, session-flag, and frame-flag tables without changing protocol descriptions.

docs/protocol.md

testing.mdAlign testing and CI tables +28/-28

Align testing and CI tables

• Pads the test-check, CI-job, and device-verification tables, including their long command and coverage cells.

docs/testing.md

usage.mdAlign usage reference tables +48/-48

Align usage reference tables

• Pads the target, build-switch, CLI-option, configuration-key, and error-message tables without changing their guidance.

docs/usage.md

README.mdAlign server patch table +2/-2

Align server patch table

• Pads the patch-name and description columns without changing the documented patch.

server/README.md

@compot-dev
compot-dev merged commit 73f9d06 into main Oct 16, 2026
9 checks passed
@compot-dev
compot-dev deleted the docs/align-tables branch October 16, 2026 14:38
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