Skip to content

docs: remove development-plan artefacts from JSDoc across the codebase#7

Merged
msalvatti merged 2 commits into
mainfrom
docs/remove-phase-fcm-refs-from-jsdoc
Jun 1, 2026
Merged

docs: remove development-plan artefacts from JSDoc across the codebase#7
msalvatti merged 2 commits into
mainfrom
docs/remove-phase-fcm-refs-from-jsdoc

Conversation

@msalvatti

Copy link
Copy Markdown
Member

Scrubs all internal development references that leaked into the permanent source record during phased construction:

  • Remove all @see docs/DEVELOPMENT_PLAN.md §Phase X PX-Y tags (64 sites)
  • Remove Phase N narrative blocks and parentheticals from file-header JSDoc
  • Remove FCM row #N / Covers FCM row #N / Demonstrates FCM rows clauses from file-level JSDoc in source, spec, and e2e files
  • Rewrite @description Phase N e2e spec for XEnd-to-end spec for X across all API and web test suites
  • Rewrite @fileoverview E2E (FCM #N): description → plain description in web e2e specs
  • Replace Protects: P15-x task IDs with plain-English invariant descriptions in platform e2e specs
  • Remove the stale TODO in register/page.tsx (superseded by the design note already present in lib/tenants.ts)
  • Remove console.log calls from debug-timing.e2e-spec.ts and add proper file-header JSDoc and scenario comments
  • Strip (FCM #N) parentheticals from individual test-body comments

No logic changes — documentation and comments only.

Scrubs all internal development references that leaked into the permanent
source record during phased construction:

- Remove all `@see docs/DEVELOPMENT_PLAN.md §Phase X PX-Y` tags (64 sites)
- Remove `Phase N` narrative blocks and parentheticals from file-header JSDoc
- Remove `FCM row #N` / `Covers FCM row #N` / `Demonstrates FCM rows` clauses
  from file-level JSDoc in source, spec, and e2e files
- Rewrite `@description Phase N e2e spec for X` → `End-to-end spec for X`
  across all API and web test suites
- Rewrite `@fileoverview E2E (FCM #N): description` → plain description
  in web e2e specs
- Replace `Protects: P15-x` task IDs with plain-English invariant descriptions
  in platform e2e specs
- Remove the stale TODO in register/page.tsx (superseded by the design note
  already present in lib/tenants.ts)
- Remove `console.log` calls from debug-timing.e2e-spec.ts and add proper
  file-header JSDoc and scenario comments
- Strip `(FCM #N)` parentheticals from individual test-body comments

No logic changes — documentation and comments only.
Copilot AI review requested due to automatic review settings June 1, 2026 21:36

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Pull request overview

Documentation-only cleanup that scrubs internal development-plan artefacts (phase references, FCM row IDs, P-task IDs, @see docs/DEVELOPMENT_PLAN.md tags) from JSDoc, file headers, and inline comments across the API and web codebases. Also tidies a stale TODO in the register page, replaces debug console.log calls with proper JSDoc/comment in debug-timing.e2e-spec.ts, and relocates a Stryker rationale comment.

Changes:

  • Removed @see docs/DEVELOPMENT_PLAN.md §Phase X PX-Y tags, Phase N narrative, and FCM #N / Covers FCM row #N references from source, spec, and e2e files.
  • Rewrote Phase N e2e spec / E2E (FCM #N) headings into plain descriptions, and replaced Protects: P15-x IDs in platform e2e specs with plain-English invariants.
  • Removed the stale TODO(P14) in register/page.tsx and the console.log calls in debug-timing.e2e-spec.ts; added a proper file header and per-test scenario comments.

Reviewed changes

Copilot reviewed 123 out of 123 changed files in this pull request and generated 4 comments.

Show a summary per file
File Description
apps/web/** (proxy, env, auth-client, components, app/, e2e specs) Strip phase/FCM references from JSDoc and test comments; clean register page TODO; rewrite e2e @fileoverview headings.
apps/api/test/** (e2e specs and helpers) Remove Phase 17 prefixes, Covers FCM row #N, and @see DEVELOPMENT_PLAN tags; add header/scenario comments and drop debug logs in debug-timing.e2e-spec.ts.
apps/api/src/** (auth, platform, projects, tenants, users, notifications, health, debug, config, account, app.module, main) Remove phase/FCM mentions from module/controller/service/DTO JSDoc and a few inline comments.
apps/web/components/platform/platform-users-table.tsx Move the Stryker rationale comment inside the component body.
.husky/pre-push Add no-op stub that defers to a global Husky init script.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread apps/api/test/auth-smoke.e2e-spec.ts Outdated
Comment thread apps/api/src/users/users.service.spec.ts Outdated
Comment thread apps/api/test/platform-isolation.e2e-spec.ts Outdated
Comment thread apps/api/test/platform-isolation.e2e-spec.ts Outdated
@msalvatti

msalvatti commented Jun 1, 2026

Copy link
Copy Markdown
Member Author
{ "consecutiveFailures": {}, "flakyReruns": {}, "processedCommentIds": [3337328351, 3337328388, 3337328411, 3337328435], "paused": false, "localGate": "pnpm typecheck && pnpm lint && pnpm test", "terminatedAt": "2026-06-01T23:10:00Z", "reason": "all-green" }

@msalvatti msalvatti merged commit 9272d22 into main Jun 1, 2026
13 checks passed
@msalvatti msalvatti deleted the docs/remove-phase-fcm-refs-from-jsdoc branch June 1, 2026 22:09
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