docs: remove development-plan artefacts from JSDoc across the codebase#7
Merged
Merged
Conversation
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.
There was a problem hiding this comment.
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-Ytags,Phase Nnarrative, andFCM #N/Covers FCM row #Nreferences from source, spec, and e2e files. - Rewrote
Phase N e2e spec/E2E (FCM #N)headings into plain descriptions, and replacedProtects: P15-xIDs in platform e2e specs with plain-English invariants. - Removed the stale
TODO(P14)inregister/page.tsxand theconsole.logcalls indebug-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.
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" } |
…and stray parentheses
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.
Scrubs all internal development references that leaked into the permanent source record during phased construction:
@see docs/DEVELOPMENT_PLAN.md §Phase X PX-Ytags (64 sites)Phase Nnarrative blocks and parentheticals from file-header JSDocFCM row #N/Covers FCM row #N/Demonstrates FCM rowsclauses from file-level JSDoc in source, spec, and e2e files@description Phase N e2e spec for X→End-to-end spec for Xacross all API and web test suites@fileoverview E2E (FCM #N): description→ plain description in web e2e specsProtects: P15-xtask IDs with plain-English invariant descriptions in platform e2e specsconsole.logcalls from debug-timing.e2e-spec.ts and add proper file-header JSDoc and scenario comments(FCM #N)parentheticals from individual test-body commentsNo logic changes — documentation and comments only.