Skip to content

docs: workspace rail, editor schema, and workflow steering - #538

Merged
huyplb merged 1 commit into
mainfrom
cursor/engineering-documentation-updates-4675
Oct 21, 2026
Merged

huyplb merged 1 commit into
mainfrom
cursor/engineering-documentation-updates-4675

Conversation

@cursor

@cursor cursor Bot commented Oct 19, 2026 •

Copy link
Copy Markdown
Contributor

Living docs were still describing the workspace switcher inside the profile menu, and they missed several behaviors shipped in #526–#533.

Docs added/updated

  • docs/user-guide.md — rail workspace button, SQL Editor schema + One transaction, read-only index probes, Db2 reorg, GRANT stop-on-first-failure, workflow cancel/answer, troubleshooting
  • docs/CODE_MAP.md, docs/ARCHITECTURE.md, docs/architecture/FEATURE-MODULE-GUIDE.md — where the switcher, execute path, and workspace button live
  • docs/workflow.md — steering a paused run; saved connections stay in their workspace
  • packages/sql/src/providers/DIALECTS.md — Db2 index REORG via ADMIN_CMD and catalog case
  • docs/releases/UNRELEASED.md — ship notes for the above

Codepaths covered

  • WorkspaceRailButton / WorkspaceMenu / editorWorkspaceStorage.ts
  • POST /sql/execute → runStatements (setCurrentSchema, transaction)
  • selectOnlyConnection (schema explorer → Destinations)
  • isSafeIndexFragmentationCustomSql and db2.index-fragmentation.ts
  • runAccessSql / Clone Table stopOnError
  • Workflow proxy ENGINE_ROUTES + WorkflowConnectionGrants.notUsableBy; Runs panel cancel / answer / resume

Knowledge gaps addressed

  • Switching workspaces is the rail button (hidden on a launch session), not the profile menu
  • Unqualified SQL follows the saved/browsed schema, not the DB user default
  • One transaction is per destination and does not wrap code cells or @set
  • Custom index SQL cannot write; Db2 cannot reorg a single index
  • A workflow cannot use another workspace’s saved connection, including when steering an in-flight run

Verified with npx vitest run packages/shared/src/doc-paths.test.ts packages/shared/src/naming.test.ts (31 passed, 2 skipped).

Open in Web View Automation 

Note

Low Risk
Markdown and agent-memory updates only; no runtime, API, or security behavior changes in this PR.

Overview
Documentation-only — brings user-facing and architecture docs in line with behaviors from #526–#533; no application code in this diff.

Workspace UX is rewritten everywhere it was wrong: switching/members/invites live under the Fox mark rail (WorkspaceRailButton → WorkspaceMenu), not the profile menu; launch sessions hide the control; SQL editor tabs are described as per-workspace in browser storage (editorWorkspaceStorage.ts).

SQL Editor docs now cover Run applying the saved/browsed schema, schema explorer selecting a single destination, One transaction per destination (excluding code cells / @set), read-only custom index probes, and Db2 table-wide index reorg + catalog quoting.

Workflow docs add run steering (cancel, answer Ask a person, resume) and workspace-scoped connections on save/run/steer via WorkflowConnectionGrants.notUsableBy.

Utilities / Access clarify GRANT/REVOKE and Clone Table stop on first failure (not one transaction); CODE_MAP / ARCHITECTURE / FEATURE-MODULE-GUIDE point maintainers at the right modules; UNRELEASED and DIALECTS.md get matching ship notes.

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

Document the rail workspace switcher, SQL Editor current-schema and
one-transaction behavior, Db2 catalog-name reorg, read-only index probes,
and workspace-scoped workflow connections — verified against the code
shipped in #526–#533.

Co-authored-by: huy.ph1988 <huy.ph1988@gmail.com>
@huyplb
huyplb marked this pull request as ready for review October 21, 2026 04:18
@huyplb
huyplb merged commit 7e8d9fa into main Oct 21, 2026
11 checks passed
@huyplb
huyplb deleted the cursor/engineering-documentation-updates-4675 branch October 21, 2026 04:18
@cursor

cursor Bot commented Oct 21, 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: daade465-771a-4776-a95f-67fdd4528979)

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