docs: Snapshots, Utils workspace, origin policy, and dialect list - #438
Merged
Merged
Conversation
The left rail is Compare / Editor / Utils / Snapshots, not Schema Sync plus a SQL Editor sidebar. History split into Snapshots (Lokee) and Applies (migration runs). README lists all 14 SQL dialects. Co-authored-by: huy.ph1988 <huy.ph1988@gmail.com>
Record FOX_ALLOWED_ORIGINS and the literal-IP dev allowlist, the E2E rate-limit helper and suite timeouts, DIALECTS.md as tracked, and assertKnownFromPorts at workflow save. Point agent memory at the Utils workspace instead of the SQL Editor sidebar. Co-authored-by: huy.ph1988 <huy.ph1988@gmail.com>
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: serverGenReqId_15c84462-56f6-4be0-84f7-1c5a06796eb4) |
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 engineering-docs pass against main (0.2.265). No product-code changes.
Docs added/updated
FOX_ALLOWED_ORIGINSand the literal-IP dev allowlist.DIALECTS.mdis tracked; E2E sweep timeouts and Lokee 20/min rate-limit helper;dialectFamily().fromPortrefused at save.Codepaths covered
UtilitiesView.tsx(Utils workspace; Editor sidebarutilities/filesreturn null)LokeeWeaveView/ForceMigrateModal/reversalGate(Snapshots, revert vs force-migrate)ActivityRail(Snapshots vs Applies)origin-policy.ts(FOX_ALLOWED_ORIGINS, LAN Vite Origins)alignResultGridsByKey/migrateKeysSafeForMutatingOpsdialectFamily()inprovider-settings.tsassertKnownFromPortsat workflow saveapps/e2e/scripts/run-all.mjs+rate-limited.tsKnowledge gaps addressed
npm run dev403s looked like a blank UI with no runbook.DIALECTS.mdgitignored.Verified:
npx vitest run packages/shared/src/doc-paths.test.ts(20 passed, 2 skipped).Note
Low Risk
Markdown and env-example documentation only; no runtime or API behavior changes in this diff.
Overview
Documentation-only pass (no application code in the diff). Docs are brought in line with current UI and ops behavior from ~0.2.265.
Navigation & workspaces: User-facing copy now uses the left rail (Compare, Editor, Utils, Snapshots, Creds, Applies) and treats Utils as its own workspace (Index Management, Clone Table, insights, DB users & grants, Query files)—not a SQL Editor sidebar. Snapshots (Lokee schema history) is separated from Applies (migration run history). Home, credential grouping, and agent memory (
sql-editor-agent-memory.mdc) are updated the same way.Deploy & troubleshooting:
.env.exampleandDEPLOYMENT.mddocumentFOX_ALLOWED_ORIGINSand dev origin rules (literal LAN IPs on 5173/5199/3210/3211).USER_GUIDE.mdadds origin 403 troubleshooting andFOXFLOW_FILES_DIRin workflow env examples.Product behavior in prose: SQL Editor section moves utilities detail into a Utilities chapter; adds Same DB warning rules, partial-page data-compare behavior, and Edit/Delete unique-key requirements for data migrate. Snapshots documents revert vs force-migrate and shared
normalizeDefinitionTextwith Compare.Contributor / architecture:
README.md/ARCHITECTURE.mdlist 14 SQL dialects (+ MongoDB/Redis settings-only).CONTRIBUTING.mdnotes trackedDIALECTS.md, E2E sweep timeouts inrun-all.mjs, andrate-limited.tsfor Lokee/db-access 20/min limits; conventions pushdialectFamily()over hand-rolled dialect chains.CODE_MAP.md,WORKFLOW.md, andUNRELEASED.mdmirror workspace split, origin policy, and workflow save-timefromPortvalidation.Reviewed by Cursor Bugbot for commit 55c152e. Bugbot is set up for automated code reviews on this repo. Configure here.