docs: drop internal project-planning status from the Sphinx site - #618
Conversation
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>
|
Warning Review limit reached
Next review available in: 42 minutes Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available. How can I continue?After more reviews become available, a review can be triggered using the 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 configurationConfiguration used: Organization UI Review profile: ASSERTIVE Plan: Pro Plus Run ID: 📒 Files selected for processing (4)
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. Comment |
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:
production-readiness.rstsecurity-audit.rstThey 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 toproduction-hardening.rstas an up-front checklist, with the issue references stripped since each item is already documented in detail further down that page.scalability.rstandstorage-redundancy.rststay. 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.rstlinks to both.Verification
:doc:references remain (the two removed pages were the only ones cross-linking each other).adjudication-explainability.rstwas already outside the toctree).Docs-only — no code or compose changes.
🤖 Generated with Claude Code