docs: Backup & Restore, Grants grid, and first-run sign-in - #480
Merged
Merged
Conversation
Document Utils backup commands (written, never run), the Access Grants grid opening on held privileges, required admin sign-in, idle sessions, and the dialect/test-id contributor paths that shipped after the last docs pass. Co-authored-by: huy.ph1988 <huy.ph1988@gmail.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_016PyNv48vpYUw2HhpjYFNUi
…d ones (#484) The pass predates #484, which added "Run backup now" (server-side SQL, after confirmation, needs editor.ddl), the history listing for SQL Server, Db2 and ClickHouse, and the one Grants view with routine grants and the also-holds line. "Fox Schema never runs them" is no longer true of backups; it is still true of restores. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_016PyNv48vpYUw2HhpjYFNUi
huyplb
marked this pull request as ready for review
October 6, 2026 16:14
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: 12f622f3-d268-4c94-870b-fa1b09fe558d) |
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 against main since 2026-09-28. Updates existing guides only — no new pages.
Docs added/updated
npm run test-ids.npm ci.Codepaths covered
packages/sql/.../backup.ts+providers/<d>/*.backup.ts+GET/PUT /api/backup-settingsheldGridPermissions/compileGridChanges) vs Permission DiffFOX_SESSION_IDLE_HOURS, profile Sign out other sessionsscripts/test-ids/)Gaps addressed
DIALECTS.mdwas still called gitignored; security docs still said the lockfile was gitignored.Note
Low Risk
Documentation and contributor-guide updates only; no runtime, auth, or backup execution logic is modified in this diff.
Overview
This PR is a documentation-only pass that brings user, architecture, and contributor guides in line with recently shipped behavior—no application code changes.
User-facing (
USER_GUIDE.md,UNRELEASED.md) documents Utils → Backup & Restore (command generation vs confirmed server-side SQL backup only; restores never auto-run), reframes first run as required admin sign-in/setup code, explains Access → Grants (grid opens on held privileges; SQL is diff-only; Diff is separate), and adds 8-hour idle sessions plus Sign out other sessions.Contributor / map docs (
ARCHITECTURE.md,CODE_MAP.md,DIALECTS.md,CONTRIBUTING.md, agent memory) point backup work at*.backup.ts,backup.registry.ts, andpackages/server/.../backupforGET/PUT /api/backup-settings; noteDIALECTS.mdis tracked (not gitignored); and document the E2Edata-testidcatalog (byTestId,npm run test-ids, MCP).Security docs now state
package-lock.jsonis committed and CI audit usesnpm ci.Reviewed by Cursor Bugbot for commit 6660789. Bugbot is set up for automated code reviews on this repo. Configure here.