Repository navigation
docs: document each query context parameter once in the query context reference - #20646
FrankChen021 wants to merge 2 commits into
Conversation
… reference Render every public query context parameter once in query-context-reference.md, and replace the parameter tables in the scan, search, groupBy, Dart, SQL query context, vectorization and MSQ reference docs with generated summary tables that link to it. Documents select parameters with metadata filters in their markers, so headings and grouping live in the docs rather than in the generator. Move the vectorization explanation to its own page, and make links in parameter descriptions work from any docs directory.
5df1833 to
97e40d3
Compare
FrankChen021
left a comment
FrankChen021
left a comment
There was a problem hiding this comment.
🟡 Changes recommended
Static review covered all 16 changed files in the prepared worktree. The documentation change removes the Join filter section while retaining a misplaced anchor, omits the INSERT/REPLACE statement scope for catalogValidationEnabled, and adds trailing whitespace that fails git diff --check.
Reviewed 16 of 16 changed files; findings in 3 files.
Validation: git diff --check reports trailing whitespace at docs/querying/vectorization.md:35. Maven tests/builds were not run; this was a static review.
| Severity | Findings |
|---|---|
| P0 | 0 |
| P1 | 0 |
| P2 | 2 |
| P3 | 1 |
| Total | 3 |
This is an automated review by Codex GPT-5.6-Luna(max)
After addressing the findings or replying to the comments, you can request another review from me to trigger a new automated review.
- Restore a Join filter parameters section in the query context reference, with the #join-filter anchor on it - Declare that catalogValidationEnabled applies to INSERT and REPLACE - Remove trailing whitespace from vectorization.md
FrankChen021
left a comment
FrankChen021
left a comment
There was a problem hiding this comment.
🟢 Approval recommended
No actionable issues found in this review. The current head resolves the prior findings, and the full documentation-generator refactor and generated documentation are internally consistent.
Reviewed 16 of 16 changed files.
Validation: git diff --check passed. jq empty website/sidebars.json passed. No builds or tests were run; this was a static review.
This is an automated review by Codex GPT-5.6-Luna(max)
FrankChen021
added
the
Approval Recommended
Description
Query context parameters were documented across seven pages, often more than once. This causes two problems:
This PR documents each parameter once in
query-context-reference.md, with its type, default, engines and query types. The scan, search, groupBy, Dart, SQL query context and MSQ reference pages now show a summary table that links to the reference.Preview