Skip to content

docs: align README with the repository standard - #10

Merged
TheStreamCode merged 1 commit into
mainfrom
docs/readme-standard-alignment
Oct 31, 2026
Merged

TheStreamCode merged 1 commit into
mainfrom
docs/readme-standard-alignment

Conversation

@TheStreamCode

Copy link
Copy Markdown
Owner

Problem: the README broke the STANDARD section order with an extra Wire compatibility layer section, had 6 Troubleshooting items (limit 3-5), and was 1646 words (limit 1200). H1 keeps the repo slug, consistent with the sibling plugin family.

Change: fold the wire details into the Features adapter bullet and the ADAPTER_CONTRACT.md pointer; merge the base_url-override cause into the client-restriction item and move the 401 fix to Quick start (4 Troubleshooting items); trim to 1193 words by whitespace count with no facts dropped.

Verification: no test asserts on README content; pytest 48 passed, validate-plugin.py PASS, ruff clean, markdownlint 0 issues, all 8 relative link targets exist.

Restore the STANDARD section order by folding the Wire compatibility layer into Features and the ADAPTER_CONTRACT.md pointer. Cut Troubleshooting from 6 items to 4: the base_url-override cause merges into the client-restriction item and the 401 fix moves to Quick start. Trim 1646 to 1193 words with no facts dropped.
@TheStreamCode
TheStreamCode merged commit 6377c8b into main Oct 31, 2026
6 checks passed
@TheStreamCode
TheStreamCode deleted the docs/readme-standard-alignment branch October 31, 2026 23:04
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