Skip to content

docs: Home Services (status-only) and Change Column - #592

Merged
huyplb merged 1 commit into
mainfrom
cursor/technical-documentation-upkeep-4f47
Nov 2, 2026
Merged

huyplb merged 1 commit into
mainfrom
cursor/technical-documentation-upkeep-4f47

Conversation

@cursor

@cursor cursor Bot commented Nov 2, 2026 •

Copy link
Copy Markdown
Contributor

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, missing sql-trace feature folder, dialect checklist.
  • docs/FEATURE_MAP.md + docs/feature-map/ — platform.system Services route; 159 HTTP routes / 58 e2e specs; Redis redis-editor and MongoDB mongodb-sql; closed stale gaps.
  • docs/workflow.md, docs/DEPLOYMENT.md — Services is status, not control.
  • Plan banners on docs/plans/2026-11-01-service-status.md and docs/plans/2026-11-01-safe-column-change.md so they are not read as unimplemented.

Codepaths they cover

  • Home Services: 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, no admin.services.
  • Change Column: packages/sql/src/modules/utilities/column-change.ts (planColumnChange), per-family providers/*/*.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).
  • Related pitfalls: checkConnectionName (120 chars, no control characters); MongoDB adapter _id as 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

  • Design plans from 2026-11-01 looked like the spec while the features had already shipped on main.
  • FEATURE_MAP still listed sample-bookmark Destinations, Oracle FOX_READER seed, and app.write/reads as open work.
  • CODE_MAP had no sql-trace folder 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-map regenerated docs/feature-map.html.

Open in Web View Automation 

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 or admin.services yet. Touches user-guide.md, CODE_MAP.md, DEPLOYMENT.md, workflow.md, and platform.system rows in FEATURE_MAP.md / feature-map/data.js.

Utilities → Change Column: Documents browser-side planColumnChange, per-dialect *.column-change.ts registry, v1 engine coverage, and that Fox runs nothing from the panel. Adds dialect checklist and “where does my change go” entries in ARCHITECTURE.md / CODE_MAP.md, plus utilities.columns in the feature map.

Other doc corrections: MongoDB _id/projection behavior, checkConnectionName, SQL editor run-rail In [n] and sample bookmarks keeping Destinations, sql-trace in 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.

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
huyplb marked this pull request as ready for review November 2, 2026 23:05

@huyplb huyplb left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Docs-only: Home Services and Change Column. CI is green.

@huyplb
huyplb merged commit 9c80d41 into main Nov 2, 2026
11 checks passed
@huyplb
huyplb deleted the cursor/technical-documentation-upkeep-4f47 branch November 2, 2026 23:06
@cursor

cursor Bot commented Nov 2, 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: 7ef6165c-919b-41d4-8058-43782619c997)

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