Skip to content

docs: drop internal project-planning status from the Sphinx site - #618

Merged
NotYuSheng merged 1 commit into
mainfrom
docs/remove-internal-planning-status
Jul 28, 2026
Merged

docs: drop internal project-planning status from the Sphinx site#618
NotYuSheng merged 1 commit into
mainfrom
docs/remove-internal-planning-status

Conversation

@NotYuSheng

Copy link
Copy Markdown
Owner

Problem

Two of the pages I added in #603 were project tracking rendered as documentation, sitting alongside pages that tell an operator how to run the system:

Page Issue refs Status language What it is
production-readiness.rst 50 14 Stage 1 checklist, Open/Done/Partial columns, effort estimates in weeks
security-audit.rst 10 3 Findings list + "Outstanding Work"

They also rot on every merge — and both were already wrong, listing backups and credential rotation as open after #611 and #595 shipped.

The analysis isn't lost. It lives in #364, #365 and #366, where it originated and where it stays current.

What's kept

security-audit.rst's "Deployment Requirements" is genuine operator guidance, not status — override credentials, restrict exposed services, terminate TLS, set CORS, use a local LLM. That moves to production-hardening.rst as an up-front checklist, with the issue references stripped since each item is already documented in detail further down that page.

scalability.rst and storage-redundancy.rst stay. These are reference material an operator actually needs — rows per GB, indexing, partitioning, the MinIO SPOF and its SNMD/MNMD upgrade paths — with almost no status language (2 and 0 status words respectively). backup-restore.rst links to both.

Verification

  • No dangling :doc: references remain (the two removed pages were the only ones cross-linking each other).
  • Sphinx builds with no new warnings — the one remaining warning is pre-existing and unrelated (adjudication-explainability.rst was already outside the toctree).
  • Operations section now renders: backup-restore, logs-monitoring, production-hardening, scalability, storage-redundancy.

Docs-only — no code or compose changes.

🤖 Generated with Claude Code

production-readiness.rst and security-audit.rst were project tracking rendered
as documentation: a Stage 1 checklist with Open/Done/Partial columns, effort
estimates in weeks, and ~60 issue references between them. That belongs in the
issue tracker, not on a site whose other pages tell an operator how to run the
thing — and it goes stale on every merge. Both were already wrong, listing
backups and credential rotation as open after #611 and #595 shipped.

The analysis is not lost: it lives in #364, #365 and #366 where it originated.

Kept the operator-facing half of security-audit.rst — its "Deployment
Requirements" list is real guidance, not status, so it moves to
production-hardening.rst as an up-front checklist (issue references stripped,
since each item is already documented in detail on that page).

scalability.rst and storage-redundancy.rst stay. Those are reference material an
operator needs — rows per GB, indexing, partitioning, the MinIO SPOF and its
SNMD/MNMD upgrade paths — with almost no status language, and backup-restore.rst
links to both.

Verified: no dangling :doc: references remain and Sphinx builds with no new
warnings.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
@coderabbitai

coderabbitai Bot commented Jul 28, 2026

Copy link
Copy Markdown

Warning

Review limit reached

@NotYuSheng, you've reached your PR review limit, so we couldn't start this review.

Next review available in: 42 minutes

Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available.
You're only billed for reviews past your plan's rate limits ($0.25/file).

How can I continue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews.

How do review limits work?

CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability.

For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window.

Please refer docs for additional details.

Review details
⚙️ Run configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Pro Plus

Run ID: 567752b6-5a9a-4c43-abae-b5c9456a561a

📥 Commits

Reviewing files that changed from the base of the PR and between dc4cffc and d5a0b78.

📒 Files selected for processing (4)
  • docs/index.rst
  • docs/operations/production-hardening.rst
  • docs/operations/production-readiness.rst
  • docs/operations/security-audit.rst

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.

@NotYuSheng
NotYuSheng merged commit 2003bea into main Jul 28, 2026
3 checks passed
@NotYuSheng
NotYuSheng deleted the docs/remove-internal-planning-status branch July 28, 2026 04:21
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.

1 participant