Repository navigation
docs: workspace rail, editor schema, and workflow steering - #538
Merged
Merged
Conversation
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: daade465-771a-4776-a95f-67fdd4528979) |
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 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, troubleshootingdocs/CODE_MAP.md,docs/ARCHITECTURE.md,docs/architecture/FEATURE-MODULE-GUIDE.md— where the switcher, execute path, and workspace button livedocs/workflow.md— steering a paused run; saved connections stay in their workspacepackages/sql/src/providers/DIALECTS.md— Db2 index REORG viaADMIN_CMDand catalog casedocs/releases/UNRELEASED.md— ship notes for the aboveCodepaths covered
WorkspaceRailButton/WorkspaceMenu/editorWorkspaceStorage.tsPOST /sql/execute→runStatements(setCurrentSchema,transaction)selectOnlyConnection(schema explorer → Destinations)isSafeIndexFragmentationCustomSqlanddb2.index-fragmentation.tsrunAccessSql/ Clone TablestopOnErrorENGINE_ROUTES+WorkflowConnectionGrants.notUsableBy; Runs panel cancel / answer / resumeKnowledge gaps addressed
@setVerified with
npx vitest run packages/shared/src/doc-paths.test.ts packages/shared/src/naming.test.ts(31 passed, 2 skipped).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.