Skip to content

Refer to Enumerations Instead of Counting Them in OPERATIONS.md - #572

Merged
ptr727 merged 3 commits into
developfrom
docs/operations-incidental-counts
Oct 30, 2026
Merged

ptr727 merged 3 commits into
developfrom
docs/operations-incidental-counts

Conversation

@ptr727

@ptr727 ptr727 commented Oct 30, 2026

Copy link
Copy Markdown
Owner

Summary

Brings OPERATIONS.md in line with the carried GOVERNANCE.md "Incidental Counts" rule, for #547.

  • Each count that restated the size of a list or table beside it now refers to the enumeration instead, for example "The following jq mistakes" and "The results below".
  • The retention limit stays, since a reader needs the number. It now names its sources: KEEP_RELEASES in make-release.sh and the host's blog-prune-releases.timer.
  • "Both" stays where it counts a fixed pair, such as one server's production and staging sites, per "Environments": "Each pair is one publish site and one staging site".
  • The heading "The log is three tiers" becomes "The log is tiered", so the one link to its anchor, in deploy/README.md, follows. The same file's "Three behaviors" lead-in becomes "Each behavior below".

The issue closes from the promotion pull request.

Local review

Three recorded local strict-review passes. The first raised 12 findings, the second 2, and the third none.

  • Fixed: lost antecedents ("These" pointing forward, "Its pages"), a widened claim ("every alternative"), a stale locator ("earlier in this section"), and missed counts at lines 128, 136, 422, 596, and 604.
  • Declined: the production/staging counts in "Server Hardening" and "The Deploy Key". Each counts a fixed pair, which the rule leaves alone.

Pre-existing findings, not filed

  • OPERATIONS.md (lines 351, 353, 410, 422, 498, 500, 544, 558) and deploy/README.md:328, style: the local prose gate's sentence-length rule flags sentences that this change did not write, on paragraph lines it touched. The CI-pinned prose gate carries no such rule.

Verification

  • markdownlint-cli2 and editorconfig-checker through the hub's docker_lint.py: clean.
  • prose_lint.py --diff: no rule other than the sentence-length findings above.
  • A whole-tree grep finds no reference to the old anchors.

🤖 Generated with Claude Code

ptr727 and others added 3 commits October 30, 2026 07:55
The carried Incidental Counts rule says text names an enumeration
rather than stating its size, since a stated count is a second copy
nothing keeps in sync. Each count that restated a list or table beside
it now refers to the enumeration. The retention limit stays and names
its sources, and fixed pairs keep "both".

Renaming the log-tiers heading moves its anchor, so the one link to it
in deploy/README.md follows.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
The local strict review found rewrites that lost their antecedent or
widened their claim, and further counts beside their enumerations.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Copilot AI lite review requested due to automatic review settings October 30, 2026 15:05
@ptr727

ptr727 commented Oct 30, 2026

Copy link
Copy Markdown
Owner Author

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

@coderabbitai

coderabbitai Bot commented Oct 30, 2026

Copy link
Copy Markdown

Important

  • 🔍 Trigger review

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

Run configuration
  • Source mode: Auto
  • Repository: Unavailable
  • Branch: Unavailable
  • File: No configuration file from this repository applied
  • Commit: Unavailable
  • Layers: Organization UI
  • Review profile: ASSERTIVE
  • Plan: Advanced
  • Run ID: a802a46f-f0b2-4196-80a3-32f9be14626d
  • 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

Choose a reason for hiding this comment

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

🟢 Approval recommended

No active review issues remain for the documentation updates.

No open issues 🎉

What changed in this PR

This documentation-only pull request updates OPERATIONS.md to follow the incidental-counts rule while preserving meaningful limits and updating dependent references in deploy/README.md.

Changes:

  • Replaces incidental list and table counts with references to the relevant enumerations.
  • Documents the sources of release-retention limits.
  • Renames the log-tier heading and updates its anchor reference.
  • Updates related operational wording in deploy/README.md.
File Description
OPERATIONS.md Removes incidental counts, preserves sourced operational limits, clarifies related prose, and renames the log-tier heading.
deploy/​README.md Updates the renamed OPERATIONS.md anchor and replaces an incidental behavior count.

Review effort: Lite

@codecov

codecov Bot commented Oct 30, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 67.12%. Comparing base (3b107de) to head (bacc7cd).

Additional details and impacted files
@@           Coverage Diff            @@
##           develop     #572   +/-   ##
========================================
  Coverage    67.12%   67.12%           
========================================
  Files           11       11           
  Lines         2494     2494           
========================================
  Hits          1674     1674           
  Misses         820      820           
Flag Coverage Δ
python-3.13 67.12% <ø> (ø)

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.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@ptr727
ptr727 merged commit 21d6a08 into develop Oct 30, 2026
13 checks passed
@ptr727
ptr727 deleted the docs/operations-incidental-counts branch October 30, 2026 15:12
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