Repository navigation
docs: Home Services (status-only) and Change Column - #592
Merged
Merged
Conversation
Home → Services shipped as status only (#587); Utilities → Change Column ships the planner and review SQL (#588/#589). Record both in the user guide, code map, feature map, architecture, and workflow runbook, and close FEATURE_MAP gaps that those PRs already fixed. Co-authored-by: huy.ph1988 <huy.ph1988@gmail.com>
huyplb
marked this pull request as ready for review
November 2, 2026 23:05
huyplb
approved these changes
Nov 2, 2026
huyplb
left a comment
Contributor
There was a problem hiding this comment.
Docs-only: Home Services and Change Column. CI is green.
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: 7ef6165c-919b-41d4-8058-43782619c997) |
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.
Docs added/updated
Living docs, not new pages:
docs/user-guide.md— Home Services card; Utilities → Change Column; MongoDB_id/ named-column SELECT; connection-name rule; run-rail In [n] selects only that statement; sample bookmarks keep Destinations; workflow troubleshooting.docs/CODE_MAP.md/docs/ARCHITECTURE.md—GET /api/system/services,planColumnChange+column-change.registry.ts, missingsql-tracefeature folder, dialect checklist.docs/FEATURE_MAP.md+docs/feature-map/—platform.systemServices route; 159 HTTP routes / 58 e2e specs; Redisredis-editorand MongoDBmongodb-sql; closed stale gaps.docs/workflow.md,docs/DEPLOYMENT.md— Services is status, not control.docs/plans/2026-11-01-service-status.mdanddocs/plans/2026-11-01-safe-column-change.mdso they are not read as unimplemented.Codepaths they cover
packages/server/src/features/system/service-status.ts(readServiceStatus),GET /api/system/services,apps/web/.../ServiceStatusCard.tsx. Engine states:running/not_configured/unreachable. No Start/Stop, noadmin.services.packages/sql/src/modules/utilities/column-change.ts(planColumnChange), per-familyproviders/*/*.column-change.ts,apps/web/.../ColumnChangePanel.tsx. Computed in the browser; Fox runs none of it. Engines: PostgreSQL, YugabyteDB, CockroachDB, MySQL, MariaDB, TiDB, SQL Server, Azure SQL (not Redshift/SQLite/Oracle/Db2).checkConnectionName(120 chars, no control characters); MongoDB adapter_idas text + named-column projection; SQL editor rail selects one statement; sample bookmark Destinations (fix(sql-editor): opening a sample bookmark keeps the checked Destinations #575).Knowledge gaps addressed
FOX_READERseed, andapp.write/readsas open work.sql-tracefolder and no column-change registry.Verified against source; 81 unit tests for the documented behavior (service-status, ColumnChangePanel, connection-name, feature-map build) passed.
npm run docs:feature-mapregenerateddocs/feature-map.html.Note
Low Risk
Documentation-only changes with no runtime or API behavior modified in this diff.
Overview
Updates living documentation so it matches features already on main, instead of leaving November design plans and stale inventory as the source of truth.
Home Services (status only): Documents the Home Services card,
GET /api/system/services, and engine states (running/not_configured/unreachable). Clarifies there is no Start/Stop oradmin.servicesyet. Touchesuser-guide.md,CODE_MAP.md,DEPLOYMENT.md,workflow.md, andplatform.systemrows inFEATURE_MAP.md/feature-map/data.js.Utilities → Change Column: Documents browser-side
planColumnChange, per-dialect*.column-change.tsregistry, v1 engine coverage, and that Fox runs nothing from the panel. Adds dialect checklist and “where does my change go” entries inARCHITECTURE.md/CODE_MAP.md, plusutilities.columnsin the feature map.Other doc corrections: MongoDB
_id/projection behavior,checkConnectionName, SQL editor run-rail In [n] and sample bookmarks keeping Destinations,sql-tracein CODE_MAP, refreshed route/e2e counts (159 routes, 58 e2e), closed stale gaps (sample bookmark bug, Oracle seed note), and shipped banners on the 2026-11-01 service-status and safe-column-change plans.Reviewed by Cursor Bugbot for commit 53bfaab. Bugbot is set up for automated code reviews on this repo. Configure here.