Skip to content

docs: workspaces, SQL readings, and Execute review - #525

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

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

Conversation

@cursor

@cursor cursor Bot commented Oct 12, 2026 •

Copy link
Copy Markdown
Contributor

Weekly documentation pass (cron) against source as of 0.2.334. No product-code changes.

Docs added/updated

  • USER_GUIDE.md — new Workspaces section; Execute conflict review; SQL priced by destination dialect; troubleshooting for connections that “disappeared” after a switch.
  • ARCHITECTURE.md — request scoping (WorkspaceScope, 404 not 403), install vs workspace permissions, sql-text tokenizer + dialect readings, Execute gate.
  • CODE_MAP.md, CONTRIBUTING.md, DEPLOYMENT.md (FOX_ADMIN_POLICY), UNRELEASED.md, FEATURE-MODULE-GUIDE.md (status: built).

Codepaths covered

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.

Open in Web View Automation 

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, and CODE_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, and FOX_ADMIN_POLICY. Contributor notes point to route-doubles.ts for 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 a sql-readings.ts step.

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.md release notes, FEATURE-MODULE-GUIDE.md status (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.

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
huyplb marked this pull request as ready for review October 12, 2026 23:24
@huyplb
huyplb merged commit 1f7d57c into main Oct 12, 2026
11 checks passed
@huyplb
huyplb deleted the cursor/engineering-documentation-updates-9899 branch October 12, 2026 23:25
@cursor

cursor Bot commented Oct 12, 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: 30826268-d793-4219-9feb-1d276b89c6ac)

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