Repository navigation
docs: keep living docs current after 0.3.1 - #604
Merged
Merged
Conversation
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
approved these changes
Nov 9, 2026
Contributor
Author
Bugbot couldn't run - usage limit reachedBugbot 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) |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Living docs after 0.3.1. No product code changes.
Docs added/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
planColumnChange/column-change.registry.ts/ColumnChangePanel: in-placealterTypeStepsby default, large-tablerebuildStepson eight engines, all 14 SQL dialects, Run / Execute all viaPOST /api/sql/execute.NAV_FLAGS.workflow === falseinfeatureRegistry.ts: off the rail and command palette in 0.3.1; stored last-view sent Home; engine and/api/workflowunchanged.npm-publish.ymlGitHub environmentnpm-publish(OIDC / ENEEDAUTH);.dockerignorekeepsscripts/so the Docker typecheck can import it.sorting_key; missing-driver messages redact install paths.Key knowledge gaps addressed
ENEEDAUTHagain; excludingscripts/from the Docker context would fail the image typecheck.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 viaPOST /api/sql/execute(not copy-only). Workflow —NAV_FLAGS.workflow === falsehides the rail and command palette; stored last-view goes Home while engine and proxy remain. SQL splitting —CREATE/ALTERroutine bodies stay one statement. Generators / drivers — identifier quoting hardening, ClickHouseORDER BYvs catalogsorting_key, driver errors redacted in the UI. Release ops — npm Trusted Publishing must use GitHub environmentnpm-publish;.dockerignoremust not dropscripts/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 on2026-11-01-safe-column-change.mdmarks full ship.DIALECTS.mddialect 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.