Skip to content

docs: keep living docs current after 0.3.1 - #604

Merged
huyplb merged 2 commits into
mainfrom
cursor/technical-documentation-upkeep-7e6b
Nov 9, 2026
Merged

huyplb merged 2 commits into
mainfrom
cursor/technical-documentation-upkeep-7e6b

Conversation

@cursor

@cursor cursor Bot commented Nov 9, 2026 •

Copy link
Copy Markdown
Contributor

Living docs after 0.3.1. No product code changes.

Docs added/updated

  • Updated: docs/ARCHITECTURE.md, docs/CODE_MAP.md, docs/FEATURE_MAP.md (+ docs/feature-map/), docs/user-guide.md, docs/workflow.md, docs/DEPLOYMENT.md, docs/publish.md, docs/BACKEND_ARCHITECTURE.md, packages/sql/src/providers/DIALECTS.md, docs/plans/2026-11-01-safe-column-change.md (banner only; original v1 text kept as history), docs/README.md.

Codepaths they cover

  • Rename Column — planColumnChange / column-change.registry.ts / ColumnChangePanel: in-place alterTypeSteps by default, large-table rebuildSteps on eight engines, all 14 SQL dialects, Run / Execute all via POST /api/sql/execute.
  • Workflow rail — NAV_FLAGS.workflow === false in featureRegistry.ts: off the rail and command palette in 0.3.1; stored last-view sent Home; engine and /api/workflow unchanged.
  • Release — npm-publish.yml GitHub environment npm-publish (OIDC / ENEEDAUTH); .dockerignore keeps scripts/ so the Docker typecheck can import it.
  • Generator / drivers — well-formed identifier quoting and line-break flattening; ClickHouse ORDER BY quoting vs catalog sorting_key; missing-driver messages redact install paths.

Key knowledge gaps addressed

  • Architecture still described column change as “Fox runs none of it” / copy-by-default / eight engines in v1.
  • User and ops docs still said “open Workflow on the rail” after the 0.3.1 hold-back.
  • Maintainers could republish npm without the Trusted Publisher environment and hit ENEEDAUTH again; excluding scripts/ from the Docker context would fail the image typecheck.
Open in Web View Automation 

Note

Low Risk
Documentation-only updates with no runtime or build changes.

Overview
Living documentation is brought in line with 0.3.1 behavior and recent releases. No application code changes.

Product behavior now documented (previously stale): Rename Column / safe column change — all 14 SQL engines, in-place type change as default (alterTypeSteps), optional large-table path on eight engines, Run / Execute all via POST /api/sql/execute (not copy-only). Workflow — NAV_FLAGS.workflow === false hides the rail and command palette; stored last-view goes Home while engine and proxy remain. SQL splitting — CREATE/ALTER routine bodies stay one statement. Generators / drivers — identifier quoting hardening, ClickHouse ORDER BY vs catalog sorting_key, driver errors redacted in the UI. Release ops — npm Trusted Publishing must use GitHub environment npm-publish; .dockerignore must not drop scripts/ for Docker typecheck.

Inventory pages refreshed: FEATURE_MAP.md, feature-map.html / data.js (metrics, Drivers card, workflow hold-back, test counts, known gaps). Plan banner on 2026-11-01-safe-column-change.md marks full ship. DIALECTS.md dialect checklist adds column-change registration guidance.

Reviewed by Cursor Bugbot for commit d71b3a9. Bugbot is set up for automated code reviews on this repo. Configure here.

Rename Column is in-place on every SQL engine, Workflow is off the rail
in 0.3.1, and npm publish needs the GitHub environment npm-publish.

Co-authored-by: huy.ph1988 <huy.ph1988@gmail.com>
@huyplb
huyplb marked this pull request as ready for review November 9, 2026 18:33
@huyplb
huyplb merged commit 6a3fa67 into main Nov 9, 2026
11 checks passed
@huyplb
huyplb deleted the cursor/technical-documentation-upkeep-7e6b branch November 9, 2026 18:33
@cursor

cursor Bot commented Nov 9, 2026

Copy link
Copy Markdown
Contributor Author

Bugbot couldn't run - usage limit reached

Bugbot is counted against Cursor usage for this user or team, and this run hit a usage or spend limit.

A user or team admin can review and increase usage limits in the Cursor dashboard.

(requestId: 2813cb2e-1300-4326-8252-4ad6692e388f)

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