docs: prune obsolete process docs, consolidate SQL doc guidance, fix scalar-domain reference - #330
Conversation
Remove the completed-effort reference-sync cluster (documentation-blockers, documentation-questions, reference-sync-notes, reference-sync-rules) — empty stubs and their rules doc, self-referential with no live consumer. Merge sql-documentation-standards + sql-documentation-templates into a single docs/development/sql-documentation.md, cross-linked to CLAUDE.md as the source of truth, and drop the dead Operator Class / Composite Type templates that contradict the v3 jsonb-domain footgun rules. Update the stale reference-sync example in docs_v3_grep.sh's comment.
Verification pass over docs/reference/adding-a-scalar-encrypted-domain-type.md found several stale or wrong claims; fix them all: - Drop the stale 'codegen gates the PostgreSQL test matrix' claim (sections 4 and 6); the gate was removed (test job needs only changes/setup/build-archive). - Fix filename tasks/pin_search_path.sql -> pin_search_path_v3.sql (5 refs). - Fix non-compiling example int_values!(.., INT4) -> INT4_FIXTURES. - Rewrite section 6 stage-4 to match generate_type: ensure_generated_paths_writable -> write_generated_file -> remove_generated_orphans (no clean_generated_files in that path). - Correct text domain count (five -> six) and 'operators' vs 'CREATE OPERATOR statements' wording; intro reference range 5-7 -> 5-8. - Misc precision nits: text pivots (only mid_pivot overridden), SignedScalar also for timestamptz, binding output paths, int_values! location, splinter constructors/comparators label, self-containment gate pointer.
|
Important Review skippedAuto reviews are disabled on base/target branches other than the default branch. Please check the settings in the CodeRabbit UI or the ⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
✨ 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.
🧹 Nitpick comments (1)
docs/development/sql-documentation.md (1)
13-13: 📐 Maintainability & Code Quality | 🔵 Trivial | 💤 Low valueHyphenate the compound modifier.
"One sentence description" should be "one-sentence description" when used as a compound modifier before a noun.
- - `@brief` - One sentence description + - `@brief` - One-sentence description🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@docs/development/sql-documentation.md` at line 13, Update the SQL documentation wording so the `@brief` entry uses the hyphenated compound modifier form; in the documentation text around `@brief`, change the phrase describing it from “One sentence description” to “one-sentence description” when it modifies the noun.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Nitpick comments:
In `@docs/development/sql-documentation.md`:
- Line 13: Update the SQL documentation wording so the `@brief` entry uses the
hyphenated compound modifier form; in the documentation text around `@brief`,
change the phrase describing it from “One sentence description” to “one-sentence
description” when it modifies the noun.
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: 6ad5c0b0-386d-41f5-9e34-db9af9b4736f
📒 Files selected for processing (9)
docs/development/documentation-blockers.mddocs/development/documentation-questions.mddocs/development/reference-sync-notes.mddocs/development/reference-sync-rules.mddocs/development/sql-documentation-standards.mddocs/development/sql-documentation-templates.mddocs/development/sql-documentation.mddocs/reference/adding-a-scalar-encrypted-domain-type.mdtasks/test/docs_v3_grep.sh
💤 Files with no reviewable changes (6)
- docs/development/sql-documentation-templates.md
- docs/development/sql-documentation-standards.md
- docs/development/documentation-questions.md
- docs/development/reference-sync-rules.md
- docs/development/documentation-blockers.md
- docs/development/reference-sync-notes.md
What
Documentation-only cleanup of the developer/reference docs. No code, build, or behaviour changes.
Prune obsolete process docs; consolidate SQL doc guidance (
6480636a)documentation-blockers,documentation-questions,reference-sync-notes,reference-sync-rules) — empty stubs and a self-referential rules doc with no live consumer.sql-documentation-standards+sql-documentation-templatesinto a singledocs/development/sql-documentation.md, cross-linked toCLAUDE.mdas the source of truth. Drops the dead Operator Class / Composite Type templates that contradicted the v3 jsonb-domain footgun rules.docs_v3_grep.sh's comment.Correct inaccuracies in scalar encrypted-domain reference (
57428738)Verification pass over
docs/reference/adding-a-scalar-encrypted-domain-type.md:pin_search_path.sql→pin_search_path_v3.sql(5 refs).int_values!(.., INT4)→INT4_FIXTURES.generate_type(ensure_generated_paths_writable→write_generated_file→remove_generated_orphans).SignedScalarfortimestamptz, binding output paths,int_values!location, splinter labels, self-containment gate pointer).Diff
9 files changed, +346 / −484 — net removal of dead process docs.
Review note
A CodeRabbit pass flagged 19 issues, but all of them are in
docs/presentations/, an untracked POC directory (vendored reveal.js/Quarto bundles) that is not part of this branch. This PR's actual diff produced zero findings.Summary by CodeRabbit