Repository navigation
docs: workspaces, SQL readings, and Execute review - #525
Merged
Merged
Conversation
Document team workspaces (personal vs shared, invites, public join, admin join-to-open), how sql-text classifies statements the destination dialect reads, and that Execute opens the missing-FK / narrowing review instead of deploying. Co-authored-by: huy.ph1988 <huy.ph1988@gmail.com>
huyplb
approved these changes
Oct 12, 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: 30826268-d793-4219-9feb-1d276b89c6ac) |
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.
Weekly documentation pass (cron) against source as of 0.2.334. No product-code changes.
Docs added/updated
WorkspaceScope, 404 not 403), install vs workspace permissions, sql-text tokenizer + dialect readings, Execute gate.FOX_ADMIN_POLICY), UNRELEASED.md, FEATURE-MODULE-GUIDE.md (status: built).Codepaths covered
platform/workspaces,/api/workspaces,effectivePermissions, Admin → Workspaces (join to open).sql-tokens.ts/sql-readings.ts/sqlStatementCategories;/sql/executeprices fences as comments the database sees (refactor(sql): the keyword-scan stripper reads the shared tokenizer #517–fix(sql): price a code fence as the comments the database sees #522).executeGate.ts/executeClick(fix(compare): Execute opens the review for a narrowing or missing-FK conflict instead of deploying #515) — missing FK and unacked narrowing open review instead of deploying.Knowledge gaps addressed
Team workspaces (#491–#497) had no user or operator guide. sql-text was still “statement splitting and templating” after the shared tokenizer. Execute’s missing-FK / narrowing click was undocumented.
Note
Low Risk
Markdown-only changes; no runtime, security, or data-path modifications.
Overview
Documentation-only weekly pass (no application code): brings user, architecture, and contributor docs in line with shipped behavior around team workspaces, shared SQL lexing, and Compare Execute gating.
Workspaces — New/expanded coverage in
USER_GUIDE.md,ARCHITECTURE.md,DEPLOYMENT.md, andCODE_MAP.md: workspace-scoped data (connections, secrets, runs), personal vs shared workspaces, invites/public join, admin list-and-join-only,WorkspaceScope/scopeOf(req), install vs workspace permissions, andFOX_ADMIN_POLICY. Contributor notes point toroute-doubles.tsfor route tests.SQL text — Docs now describe
packages/sql/src/modules/sql-text/as a single tokenizer + per-dialect readings (not a second scanner); permission gates and classifiers must pass the destination dialect. Dialect checklist adds asql-readings.tsstep.Compare Execute — Documents
executeGate.ts: missing FK / unacknowledged narrowing keeps Execute clickable but routes the click to review; other blockers still disable the button.Also updates
UNRELEASED.mdrelease notes,FEATURE-MODULE-GUIDE.mdstatus (built), and terminology (left-rail views vs workspaces).Reviewed by Cursor Bugbot for commit dcf3c6d. Bugbot is set up for automated code reviews on this repo. Configure here.