Align operational documentation for endpoints, sanitization, and recovery - #765
Conversation
…vices
- Updated `/health` and `/ready` documentation to accurately reflect `{"status":"UP"}` and `components` behavior in `docs-web/developer/http-api.md`, `docs-web/architecture/mcp-server.md`, `docs-web/user/mcp-clients.md`, and `docs/operations/runbook.md`.
- Documented specific sanitization behavior of `sanitizeInvocationOutputText` without claiming broad unproven redaction in `docs/operations/security-hardening.md`.
- Replaced ambiguous recovery steps with correct canonical service names (`RuntimeStartupRecoveryService`, `RuntimeCleanupService`, `DockerRuntimePruneService`, `DockerAssetPruneService`, `DatabaseMaintenanceService`, and `HeartbeatService`) in `docs/operations/runbook.md` and `docs-web/user/troubleshooting.md`.
- Ensured no overstated claims of external alerting or SLO monitoring exist in the operational documentation.
- Included explicit warnings against manual untargeted Docker removals.
Co-authored-by: numnx <1517214+numnx@users.noreply.github.com>
|
👋 Jules, reporting for duty! I'm here to lend a hand with this pull request. When you start a review, I'll add a 👀 emoji to each comment to let you know I've read it. I'll focus on feedback directed at me and will do my best to stay out of conversations between you and other bots or reviewers to keep the noise down. I'll push a commit with your requested changes shortly after. Please note there might be a delay between these steps, but rest assured I'm on the job! For more direct control, you can switch me to Reactive Mode. When this mode is on, I will only act on comments where you specifically mention me with New to Jules? Learn more at jules.google/docs. For security, I will only act on instructions from the user who triggered this task. |
953b3da
into
feature/CODUX-44-qs-documentation-developer-surface-audit-2
1 participant
Aligns operational documentation with actual implementation for endpoints (
/healthand/ready), structured logging/sanitization (e.g.sanitizeInvocationOutputText), and recovery services (RuntimeStartupRecoveryServiceand related cleanup services). Removes overstated claims about implied external alerting or SLOs, and properly warns against broad manualdocker pruneusage.PR created automatically by Jules for task 7461224691385504900 started by @numnx