Repository navigation
Split the Remaining Over-Length Sentences in the Host Setup Docs - #3598
Conversation
Part of #3531 Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
|
A recorded local strict-review pass covers head |
|
Important
This repository does not receive automatic reviews because it has fewer than 10 stars.
 |
There was a problem hiding this comment.
🟡 Changes recommended
Two unresolved nit-level findings remain: reworded sentences in README.md and docs/host-setup.md depart from the verbatim wording the PR description cites, and a split sentence in docs/host-setup.md drops its reason and exceeds the 25-word cap.
2 open issues
What changed in this PR
This PR splits over-length sentences in the agent-enablement docs so they fit the sentence-length cap. The source text is hub-verbatim rulings, so the split should keep the original wording as far as possible.
Changes:
- Splits the long "What This Repo Is" paragraph and the human-contribution paragraph in the root README, turning the list of maintainer duties into bullets.
- Splits the WSL and Docker Desktop paragraph in the Windows host-setup README into shorter sentences.
- Splits the "host needs no Python" and "host-tools.json" paragraphs in the host-setup doc.
| File | Description |
|---|---|
| README.md | Splits the purpose paragraph and turns the human-contribution duties into a bullet list. Some wording changed during the split. |
| host-setup/windows/README.md | Splits the install-tools.ps1 WSL and Docker Desktop paragraph into shorter sentences with minor rewording. |
| docs/host-setup.md | Splits the Python-free and host-tools paragraphs. The Python-free split still needs a further cut to meet the cap. |
Review effort: Lite
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## develop #3598 +/- ##
==========================================
Coverage ? 81.60%
==========================================
Files ? 26
Lines ? 9070
Branches ? 0
==========================================
Hits ? 7402
Misses ? 1668
Partials ? 0
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
…down (#3600) ## Summary Promotes `develop` to `main`, carrying the sentence-length splits of the hub-only Markdown: - #3594: splits them in scripts/README.md. - #3593: splits them in STANDUP, AUDIT, RESYNC, and OPERATIONS. - #3591: splits them in TODO.md. - #3596: splits them in the agent-safety Markdown. - #3595: splits them in the host setup docs. - #3592: splits them in reusable-workflows and fleet-map. - #3598: splits them in the remaining host setup sentences. - #3597: splits them in the spec and repo-config docs. - #3599: splits them in the docs, catalog READMEs, and HISTORY. This is part of #3531, which stays open. 🤖 Generated with [Claude Code](https://claude.com/claude-code)
Part of #3531
The five sentences are orchestrator rulings applied verbatim, not author rewordings.
🤖 Generated with Claude Code