Skip to content

docs: sync documentation with recent changes - #346

Closed
nadeem4 wants to merge 1 commit into
mainfrom
docs-sync/2026-10-27
Closed

nadeem4 wants to merge 1 commit into
mainfrom
docs-sync/2026-10-27

Conversation

@nadeem4

@nadeem4 nadeem4 commented Oct 27, 2026

Copy link
Copy Markdown
Owner

Reviewed PRs merged after the previous sync PR (#338, 2026-10-17): #335, #337, #339, #340, #341, #342, #343, #344. Their own doc edits were thorough; two leftovers remained.

Corrections

  1. README.md, CLI table: nl2sql profile said "arrives in 0.8". feat(profiler): joins and column roles from bounded probes (P1) #343 shipped it (cli/commands/profile.py, profiler/). The row now describes what it does (joins and column roles from bounded probes, filed in the review queue, no model) and its options (--datasource/-d, --as, --user), and mentions nl2sql index --profile (cli/main.py).
  2. docs/observability/error-handling.md: NEEDS_CLARIFICATION was listed as "declared and not raised yet". feat(clarify): the clarifier and the needs_clarification result (L1) #339 raises it from the clarifier (pipeline/nodes/clarifier/node.py). Now documented as raised, linking the clarifier node page; CLARIFICATION_INVALID/CLARIFICATION_STALE remain correctly listed as not raised.

Notes

  • mkdocs build --strict here aborts only on the MERMAID2 "no Internet access" URL check (also on unmodified main); no broken-link or nav warnings from these edits.
  • Observation, not changed: docs/schema/profiler.md says drafting is "not in this change"; that matches the code (draft=True raises "Not built yet: P2"), so it is accurate until P2 lands.
  • Previous sync PR docs: sync documentation with recent changes #338 is still open; this one is separate.

Generated by Claude Code

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01NVCEKZ3LKCpN3N8nx4KqHe
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants