Repository navigation
Split the Over-Length Sentences in the Spec and Repo-Config Docs - #3597
Conversation
|
Important
This repository does not receive automatic reviews because it has fewer than 10 stars.
|
There was a problem hiding this comment.
🟡 Changes recommended
An active documentation nit remains in spec/readme-structure.md:23 because the quoted sentence is followed by a duplicate period.
1 open issue
What changed in this PR
This documentation-only pull request splits over-length sentences across specification, repository-configuration, operational, and onboarding documentation while preserving their meaning.
Changes:
- Splits long prose across the five specification model documents.
- Updates repository-configuration, operational, and setup documentation.
- Cleans up remaining sentence-length violations in supporting documentation.
- Review noted two minor documentation nits: duplicate punctuation in
spec/readme-structure.mdand a sentence fragment indocs/repo-config.md.
| File | Description |
|---|---|
STANDUP.md |
Splits host-signing and misconfiguration guidance. |
spec/type-model.md |
Splits type, profile, generator, and coverage guidance. |
spec/section-model.md |
Splits section-fidelity and repository-content guidance. |
spec/scope-model.md |
Splits scope and selector descriptions. |
spec/readme-structure.md |
Splits README structure, shield, link, and backlog guidance. |
spec/fidelity-model.md |
Splits fidelity, workflow-interface, and normalization guidance. |
scripts/README.md |
Splits prose-gate and host-tool layering guidance. |
repo-config/README.md |
Splits repository configuration, ruleset, label, and project guidance. |
OPERATIONS.md |
Splits project-access and configuration-verification guidance. |
docs/repo-config.md |
Splits configuration, environment, and migration guidance. |
This pull request is ready to be approved.
Review effort: Lite
Part of #3531 Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## develop #3597 +/- ##
==========================================
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:
|
|
Answering the review body item "a sentence fragment in docs/repo-config.md": it names no line, and a read of every sentence the diff adds or changes in that file found a subject and finite verb (or an imperative) in each. The duplicate-period item is fixed in the newest commit. |
…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)

What was swept
Split over-length sentences (sentence-length gate, 25 words) without changing meaning in
spec/readme-structure.md,spec/section-model.md,spec/fidelity-model.md,spec/type-model.md,spec/scope-model.md,repo-config/README.md,docs/repo-config.md, plus residue sentences inOPERATIONS.md,scripts/README.md, andSTANDUP.md.Hits before and after: readme-structure 48 to 0, section-model 26 to 0, fidelity-model 16 to 0, type-model 13 to 0, scope-model 5 to 0, repo-config/README 26 to 0, docs/repo-config 14 to 0, OPERATIONS 1 to 0, scripts/README 2 to 0, STANDUP 1 to 0.
Recorded local strict review: four frontier passes, the last with no new drift.
Deviations from the orchestrator wording
STANDUP.md: the ruled sentence was 26 words, one over the gate. It reads "A host misconfiguration shows as a missing--globalvalue, ..." instead of "Each of these is a host misconfiguration: ...".scripts/README.md"Layering is tighten-only": adopts STANDUP's wording with "A local entry", because a bare "An entry" there would widen the restriction to the hub's own file.Copies left for the comment sweep
None identical.
repo-config/configure.sh:33andspec/third-party-tools.json,spec/readme-sections.jsoncarry related but differently worded sentences.Part of #3531
🤖 Generated with Claude Code