Conversation
Reviewer's GuideReformatted and standardised markdown files to comply with markdownlint rules by reflowing lines, replacing raw HTML tables with markdown syntax, adding lint directives for long lines, and tidying up list and code block formatting across documentation and AGENTS.md. Flow diagram for documentation formatting process (flow diagram)flowchart TD
A[Start: Markdown files] --> B[Run mdformat-all]
B --> C[Run markdownlint]
C --> D[Reflow lines, replace HTML tables with markdown tables]
D --> E[Add markdownlint directives where needed]
E --> F[Standardise list and code block formatting]
F --> G[Commit formatted files]
G --> H[End]
File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
WalkthroughThis update reformats multiple documentation files for improved readability and markdown consistency. Changes include line wrapping, markdown table conversions, and markdownlint directive additions. No semantic content, code, or public APIs are altered. One document receives a new detailed roadmap section, and all other modifications are stylistic or structural in nature. Changes
Possibly related PRs
Suggested reviewers
Poem
📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (9)
🧰 Additional context used🧠 Learnings (1)docs/multi-packet-and-streaming-responses-design.md (1)🪛 LanguageToolAGENTS.md[style] ~36-~36: Consider using “except” or “except for” (WITH_THE_EXCEPTION_OF) [locale-violation] ~37-~37: license must be spelled with a “c” when used as a noun in British English. Use “licence”. (LICENCE_LICENSE_NOUN_SINGULAR) docs/hardening-wireframe-a-guide-to-production-resilience.md[style] ~30-~30: Would you like to use the Oxford spelling “synchronization”? The spelling ‘synchronisation’ is also correct. (OXFORD_SPELLING_Z_NOT_S) [uncategorized] ~32-~32: Loose punctuation mark. (UNLIKELY_OPENING_PUNCTUATION) [uncategorized] ~38-~38: Loose punctuation mark. (UNLIKELY_OPENING_PUNCTUATION) [style] ~221-~221: Consider using “many”. (NUMEROUS_DIFFERENT) [style] ~265-~265: Future tense may not be necessary in this context. (WILL_ALLOW) docs/multi-layered-testing-strategy.md[style] ~6-~6: Would you like to use the Oxford spelling “synthesizing”? The spelling ‘synthesising’ is also correct. (OXFORD_SPELLING_Z_NOT_S) [grammar] ~30-~30: An apostrophe ‘s’ denotes possession. Did you mean to use the plural form of the noun (no apostrophe)? (NOUN_APOSTROPHE_S_VERB) [style] ~31-~31: You have used the passive voice repeatedly in nearby sentences. To make your writing clearer and easier to read, consider using active voice. (REP_PASSIVE_VOICE) [style] ~54-~54: Would you like to use the Oxford spelling “serialized”? The spelling ‘serialised’ is also correct. (OXFORD_SPELLING_Z_NOT_S) [locale-violation] ~121-~121: Lower-case ‘Ok’ is American English. For British English use “OK”. (OK) [locale-violation] ~122-~122: Lower-case ‘Ok’ is American English. For British English use “OK”. (OK) [grammar] ~201-~201: “Socket” is a singular noun. It appears that the verb form is incorrect. (PCT_SINGULAR_NOUN_PLURAL_VERB_AGREEMENT) [style] ~370-~370: Consider using the typographical ellipsis character here instead. (ELLIPSIS) [style] ~416-~416: Since ownership is already implied, this phrasing may be redundant. (PRP_OWN) docs/multi-packet-and-streaming-responses-design.md[misspelling] ~10-~10: This word is normally spelled as one. (EN_COMPOUNDS_MULTI_PART) [style] ~79-~79: Would you like to use the Oxford spelling “optimized”? The spelling ‘optimised’ is also correct. (OXFORD_SPELLING_Z_NOT_S) [locale-violation] ~110-~110: Lower-case ‘Ok’ is American English. For British English use “OK”. (OK) [misspelling] ~162-~162: This word is normally spelled as one. (EN_COMPOUNDS_MULTI_PART) [style] ~239-~239: Would you like to use the Oxford spelling “prioritized”? The spelling ‘prioritised’ is also correct. (OXFORD_SPELLING_Z_NOT_S) docs/the-road-to-wireframe-1-0-feature-set-philosophy-and-capability-maturity.md[grammar] ~26-~26: Please add a punctuation mark at the end of paragraph. (PUNCTUATION_PARAGRAPH_END) [misspelling] ~31-~31: This word is normally spelled as one. (EN_COMPOUNDS_MULTI_PART) [grammar] ~174-~174: Please add a punctuation mark at the end of paragraph. (PUNCTUATION_PARAGRAPH_END) docs/wireframe-1-0-detailed-development-roadmap.md[typographical] ~6-~6: To join two clauses or introduce examples, consider using an em dash. (DASH_RULE) [typographical] ~22-~22: To join two clauses or introduce examples, consider using an em dash. (DASH_RULE) [typographical] ~23-~23: To join two clauses or introduce examples, consider using an em dash. (DASH_RULE) [style] ~24-~24: Consider using the typographical ellipsis character here instead. (ELLIPSIS) [uncategorized] ~24-~24: If this is a compound adjective that modifies the following noun, use a hyphen. (EN_COMPOUND_ADJECTIVE_INTERNAL) [typographical] ~25-~25: To join two clauses or introduce examples, consider using an em dash. (DASH_RULE) docs/observability-operability-and-maturity.md[uncategorized] ~44-~44: Loose punctuation mark. (UNLIKELY_OPENING_PUNCTUATION) [uncategorized] ~47-~47: Loose punctuation mark. (UNLIKELY_OPENING_PUNCTUATION) [uncategorized] ~50-~50: Loose punctuation mark. (UNLIKELY_OPENING_PUNCTUATION) [style] ~132-~132: To form a complete sentence, be sure to include a subject or ‘there’. (MISSING_IT_THERE) [style] ~154-~154: Would you like to use the Oxford spelling “synchronization”? The spelling ‘synchronisation’ is also correct. (OXFORD_SPELLING_Z_NOT_S) [style] ~260-~260: Would you like to use the Oxford spelling “organization”? The spelling ‘organisation’ is also correct. (OXFORD_SPELLING_Z_NOT_S) docs/generic-message-fragmentation-and-re-assembly-design.md[locale-violation] ~187-~187: Lower-case ‘Ok’ is American English. For British English use “OK”. (OK) [style] ~201-~201: Consider using the typographical ellipsis character here instead. (ELLIPSIS) [style] ~223-~223: You have used the passive voice repeatedly in nearby sentences. To make your writing clearer and easier to read, consider using active voice. (REP_PASSIVE_VOICE) ⏰ Context from checks skipped due to timeout of 90000ms (1)
🔇 Additional comments (49)
✨ Finishing Touches🧪 Generate Unit Tests
🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![sourcery-ai[bot]](https://avatars.githubusercontent.com/in/48477?s=60&v=4){kind=small}
![codescene-delta-analysis[bot]](https://avatars.githubusercontent.com/in/53921?s=60&v=4){kind=small}
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
1 participant
Summary
Testing
mdformat-allmarkdownlint *.md **/*.mdnixie *.md **/*.mdmake fmtmake lintmake testhttps://chatgpt.com/codex/tasks/task_e_6859ae1a87308322b51784e462da66f1
Summary by Sourcery
Reformat markdown documentation across the docs directory to comply with markdownlint rules and wrap text at the configured line length.
Enhancements:
CI:
Summary by CodeRabbit