docs: land the dormant doc-fix branch + meta-file staleness sweep#412
Conversation
…nt-0.34 Docs-only portion of 6759eaa (tobyhede); the code/Cargo changes are superseded by main's move to cipherstash-client 0.34.1-alpha.4.
- SECURITY.md: replace stale 2.1.x-only support table with a latest-release-line policy (current is 2.2.4); 'Use TypeScript' -> Rust; fix 'disclosures' typo - reference/index.md: [database] host default is 127.0.0.1 (database.rs), not 0.0.0.0; fix #configuring-proxy link to point at the how-to guide; remove empty 'Command line options' heading; add missing TOC entries - README: drop the stale 'Proxy V2 now available' banner - encrypt-tool.md: config file is cipherstash-proxy.toml; typo - packages/cipherstash-proxy/README: dev docs moved to DEVELOPMENT.md - showcase README: mise.local.toml snippet needs the [env] table header - tests/python/README: add title and canonical mise entry point - CONTRIBUTING: CODE_OF_CONDUCT.md is the covenant text, not a FAQ
|
Warning Review limit reached
Next review available in: 33 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: defaults Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (19)
✨ Finishing Touches🧪 Generate unit tests (beta)
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 |
There was a problem hiding this comment.
Pull request overview
This PR performs a repository-wide documentation and “meta-file” staleness sweep, largely landing the previously unmerged docs fixes from the dormant docs/sync-cipherstash-client-0.34 work and then addressing remaining inconsistencies (config defaults, metrics names, links/anchors, and various READMEs).
Changes:
- Aligns docs and example configs with the current Proxy configuration model (TLS config keys, database host defaults, CLI/config references) and fixes broken links/anchors.
- Updates integration-test READMEs and developer docs to reflect current
miseentry points, credentials, ports/passwords, and test status. - Refreshes repository meta-files (SECURITY, CONTRIBUTING, CHANGELOG, ARCHITECTURE/CLAUDE) for accuracy and consistency.
Reviewed changes
Copilot reviewed 19 out of 19 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| tests/python/README.md | Adds a title and canonical mise invocation for Python integration tests. |
| tests/integration/golang/README.md | Fixes example DATABASE_URL password encoding. |
| tests/integration/elixir_test/README.md | Updates mise command and notes Elixir tests are currently disabled. |
| SECURITY.md | Replaces stale support matrix with “latest release line” policy; fixes wording and language guidance. |
| README.md | Removes stale “Proxy V2” banner and updates Docker env-file setup instructions. |
| packages/showcase/README.md | Fixes mise.local.toml snippet and updates the recommended mise task name. |
| packages/cipherstash-proxy/README.md | Points dev docs to DEVELOPMENT.md instead of the top-level README. |
| docs/reference/searchable-json.md | Corrects TOC typo and fixes SQL example syntax/operator usage; removes redundant section. |
| docs/reference/message-flow.md | Removes SVG image embeds in favor of Mermaid diagrams. |
| docs/reference/index.md | Fixes links/typos/defaults, updates metrics list, adds missing TOC entries, and removes an empty heading. |
| docs/reference/encrypt-tool.md | Updates config filename reference and fixes a spelling error. |
| docs/how-to/index.md | Fixes relative links and replaces a TODO with concrete local-run instructions and admonition formatting. |
| docs/errors.md | Fixes anchors/duplicates, adds missing errors, and aligns an error message with code. |
| DEVELOPMENT.md | Fixes TLS/non-TLS explanation, updates test password, and corrects cert generation tool reference. |
| CONTRIBUTING.md | Fixes Code of Conduct link text and corrects LICENSE filename reference. |
| CLAUDE.md | Updates repo structure descriptions and clarifies mise run check meaning; adds [env] header to snippet. |
| cipherstash-proxy-example.toml | Updates [tls] example keys to match the current serde model. |
| CHANGELOG.md | Fixes metric name (*_hits_total) to match implementation. |
| ARCHITECTURE.md | Updates the documented directory structure to reflect current layout (cli/connect/tls/log). |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
TandemConfig reads CS_CLIENT_ID / CS_CLIENT_KEY / CS_DEFAULT_KEYSET_ID and maps them to CS_ENCRYPT__* internally (tandem.rs); every other doc and mise.local.example.toml use the short forms.
Summary
A meta-file staleness review of this repo found ~35 defects — and that ~20 of them were already fixed on
docs/sync-cipherstash-client-0.34(@tobyhede's draft PR #385, closed unmerged in June). This PR:[tls]section that didn't deserialize against the actual serde model, wrong test password/port in DEVELOPMENT.md and language-test READMEs, missing metrics rows, the "arm64-only" claim (both architectures ship), broken relative links in how-to/reference, errors.md additions, searchable-json.md cleanup, and more.ab2dad07error-variant fix,6759eaa3's tandem.rs/zerokms/Cargo changes) — main has since moved to cipherstash-client0.34.1-alpha.4, past the branch's0.34.0-alpha.4pin, so that work looks superseded. @tobyhede — worth a quick look at whether any of it should still be revived separately.[database] hostdefault documented as0.0.0.0butdatabase.rsdefaults to127.0.0.1(the[server]0.0.0.0default is genuinely correct); a self-referencing#configuring-proxyanchor; an empty "Command line options" heading; stale README "Proxy V2 now available" banner;cipherstash.toml→cipherstash-proxy.tomlin the encrypt-tool doc; the package README pointing at the root README for dev docs that live in DEVELOPMENT.md; a showcase README mise snippet missing its[env]header; and a title-less python test README.No stale protectjs/Protect.js branding exists in this repo, and no
hello@cipherstash.comoccurrences.Verification
config/tls.rs(untagged enum:certificate_path/private_key_pathor*_pem)config/server.rs(0.0.0.0) andconfig/database.rs(127.0.0.1)prometheus.rs; docs-only diff, no code touchedCloses #413