Skip to content

Split the Over-Length Sentences in the Spec and Repo-Config Docs - #3597

Merged
ptr727 merged 7 commits into
developfrom
feature/3531-md-spec-repo-config
Oct 29, 2026
Merged

ptr727 merged 7 commits into
developfrom
feature/3531-md-spec-repo-config

Conversation

@ptr727

@ptr727 ptr727 commented Oct 29, 2026

Copy link
Copy Markdown
Owner

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 in OPERATIONS.md, scripts/README.md, and STANDUP.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 --global value, ..." 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:33 and spec/third-party-tools.json, spec/readme-sections.json carry related but differently worded sentences.

Part of #3531

🤖 Generated with Claude Code

ptr727 and others added 4 commits October 28, 2026 21:17
… Docs

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:37
@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

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.md and a sentence fragment in docs/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

Comment thread spec/readme-structure.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    #3597   +/-   ##
==========================================
  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.

@ptr727

ptr727 commented Oct 29, 2026

Copy link
Copy Markdown
Owner Author

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.

ptr727 and others added 2 commits October 28, 2026 21:56
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>
@ptr727
ptr727 merged commit 11873cc into develop Oct 29, 2026
13 checks passed
@ptr727
ptr727 deleted the feature/3531-md-spec-repo-config branch October 29, 2026 05:14
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