Skip to content

Split the Over-Length Sentences in the Host Setup Docs - #3595

Merged
ptr727 merged 9 commits into
developfrom
feature/3531-md-host-setup
Oct 29, 2026
Merged

ptr727 merged 9 commits into
developfrom
feature/3531-md-host-setup

Conversation

@ptr727

@ptr727 ptr727 commented Oct 29, 2026

Copy link
Copy Markdown
Owner

Splits the over-length sentences (cap 25 words) in README.md, docs/host-setup.md, host-setup/README.md, host-setup/windows/README.md, and host-setup/linux/README.md without changing meaning.

Hit counts (prose_lint.py --check sentence-length): README.md 61 -> 2, docs/host-setup.md 70 -> 2, host-setup/README.md 30 -> 0, host-setup/windows/README.md 30 -> 1, host-setup/linux/README.md 3 -> 0.

Five sentences are left in their original form because the review kept flagging them after two fixes (README.md lines 76 and 128, docs/host-setup.md lines 57 and 61, host-setup/windows/README.md line 102). They go to an orchestrator ruling.

Copies left for the comment sweep (near-copies in code comments or JSON, not split here):

  • host-setup/windows/setup-wsl.ps1:5 (Docker settings in memory, discarded at next save) pairs with host-setup/windows/README.md line 94.
  • host-setup/linux/install-agents.sh:4 pairs with docs/host-setup.md line 222.
  • host-setup/windows/install-tools.ps1:10 and :928 pair with host-setup/windows/README.md line 46 and docs/host-setup.md line 31.
  • spec/host-tools.json:55 pairs with docs/host-setup.md line 45.

Copies in other sweep slices' Markdown, left as is: docs/fleet-map.md:149 (refresh cadence), scripts/README.md:163 (installed, answers --version, looks healthy).

Part of #3531

🤖 Generated with Claude Code

ptr727 and others added 7 commits October 28, 2026 21:16
Part of #3531

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Part of #3531

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Part of #3531

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Part of #3531

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Part of #3531

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Part of #3531

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Part of #3531

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Copilot AI lite review requested due to automatic review settings October 29, 2026 04:26
@coderabbitai

coderabbitai Bot commented Oct 29, 2026 •

Copy link
Copy Markdown

Important

  • 🔍 Trigger review

This repository does not receive automatic reviews because it has fewer than 10 stars.

Run configuration
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟡 Changes recommended

Six active documentation issues remain, including sentence-length violations and an ungrammatical review-loop sentence, so the intended lint and clarity fixes are incomplete.

6 open issues
What changed in this PR

This documentation-only pull request shortens over-length sentences across the fleet overview and host setup guides while preserving the documented procedures and behavior.

Changes:

  • Splits long prose in README.md and the host setup documentation.
  • Updates Windows and Linux setup guidance without changing scripts or configuration.
  • Clarifies bootstrap, tooling, WSL, verification, and maintenance explanations.
  • Leaves five documented sentence-length exceptions unresolved.
File Description
README.md Shortens fleet overview, workflow, onboarding, and governance prose.
host-setup/​windows/​README.md Shortens Windows tooling, WSL, Docker Desktop, and verification guidance.
host-setup/​README.md Shortens bootstrap, menu, lifecycle, and tooling architecture descriptions.
host-setup/​linux/​README.md Shortens Linux agent-tool installation and package guidance.
docs/​host-setup.md Shortens host requirements, installer behavior, verification, and agent-tool guidance.

This pull request requires changes.

Review effort: Lite

Comment thread README.md Resolved
Comment thread README.md Resolved
Comment thread README.md Resolved
Comment thread docs/host-setup.md Resolved
Comment thread docs/host-setup.md Resolved
Comment thread host-setup/windows/README.md Resolved
Part of #3531

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@codecov

codecov Bot commented Oct 29, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
⚠️ Please upload report for BASE (develop@4ddcda4). Learn more about missing BASE report.

Additional details and impacted files
@@            Coverage Diff             @@
##             develop    #3595   +/-   ##
==========================================
  Coverage           ?   81.60%           
==========================================
  Files              ?       26           
  Lines              ?     9070           
  Branches           ?        0           
==========================================
  Hits               ?     7402           
  Misses             ?     1668           
  Partials           ?        0           
Flag Coverage Δ
python-3.13 81.60% <ø> (?)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Part of #3531

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@ptr727

ptr727 commented Oct 29, 2026

Copy link
Copy Markdown
Owner Author

A recorded local strict-review pass covers head 0dece1a05d527dfb71854600cac1022403774aa3, the content this pull request carries at that commit against develop, and it recorded 3 findings.

@ptr727
ptr727 merged commit ef727b4 into develop Oct 29, 2026
13 checks passed
@ptr727
ptr727 deleted the feature/3531-md-host-setup branch October 29, 2026 04:43
ptr727 added a commit that referenced this pull request Oct 29, 2026
…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)
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.

2 participants