P0-X: Fix architectural naming drift — complete doc/tracking cleanup#75
P0-X: Fix architectural naming drift — complete doc/tracking cleanup#75
Conversation
|
@copilot This may already be done and just failed to be referenced. Check the current code base and issues status. Mark as complete anything completed and just limit your work to review and cleanup. |
Co-authored-by: devlux76 <86517969+devlux76@users.noreply.github.com>
Confirmed — all P0-X rename work was already complete in the TypeScript sources (
All 211 unit tests pass and lint is clean. The CI |
There was a problem hiding this comment.
Pull request overview
Closes out the remaining documentation/tracking updates for the completed “Metroid (proximity graph) → SemanticNeighbor (proximity graph)” rename, ensuring “Metroid” remains reserved for the { m1, m2, c } dialectical probe concept.
Changes:
- Updates API docs to use
SemanticNeighbor/SemanticNeighborSubgraphand the renamedMetadataStoreneighbor-graph method names. - Removes/updates stale “rename pending” notes in
DESIGN.mdand resolves the naming-drift blocker status inPLAN.md. - Marks P0-X items complete in
TODO.mdand adds a “resolved” update inARCHITECTURE-REVIEW.md.
Reviewed changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| docs/api.md | Renames proximity-graph types/methods in the published API documentation. |
| DESIGN.md | Removes stale callouts implying the rename is still pending. |
| PLAN.md | Updates plan rows and marks the naming-drift blocker as resolved. |
| TODO.md | Checks off P0-X tasks and updates the quick-reference section. |
| ARCHITECTURE-REVIEW.md | Adds a resolution status update while retaining the historical divergence catalog. |
| - [ ] **P0-X6:** Rename IndexedDB object store from `metroid_neighbors` → `neighbor_graph` | ||
| - [x] **P0-X6:** Rename IndexedDB object store from `metroid_neighbors` → `neighbor_graph` | ||
| - Increment `DB_VERSION` in `storage/IndexedDbMetadataStore.ts` | ||
| - Add migration in `applyUpgrade` to copy data from old store to new store |
There was a problem hiding this comment.
@copilot no migration is needed. This is fresh code. Just remove the references to it.
There was a problem hiding this comment.
Removed the migration sub-bullets from P0-X6. The entry now simply reads - [x] **P0-X6:** Rename IndexedDB object store from 'metroid_neighbors' → 'neighbor_graph' with no migration notes. Commit: 97d445b.
| #### `SemanticNeighbor` | ||
|
|
||
| A nearest-neighbour entry in the Metroid radius graph (a project-domain term for the medoid-inspired NN graph). | ||
| A nearest-neighbour entry in the semantic neighbor radius graph — a sparse proximity graph connecting pages with high cosine similarity, used for BFS subgraph expansion during retrieval. |
There was a problem hiding this comment.
@copilot Good catch and critical at P0 level. I'd recommend you scour the code base and fix any and all inconsistencies like that. I'm American so we may as well settle on American rather than English ☕️
There was a problem hiding this comment.
Scoured the full codebase — found and fixed all three occurrences of "neighbour" in docs/api.md, core/types.ts, and README.md. No British spellings remain. Commit: 6582cbe.
| **Scope:** Full repository audit against corrected DESIGN.md (v1.2) | ||
| **Status:** Documentation-only pass; no code changes made in this review | ||
|
|
||
| **Update (P0-X resolved):** All P0-X naming drift items (D1–D9) have been corrected. `SemanticNeighbor`, `SemanticNeighborSubgraph`, `putSemanticNeighbors`, `getSemanticNeighbors`, `getInducedNeighborSubgraph`, `needsNeighborRecalc`, `flagVolumeForNeighborRecalc`, and `clearNeighborRecalcFlag` are now in place throughout `core/types.ts`, `storage/IndexedDbMetadataStore.ts`, `cortex/Query.ts`, and all test files. The IDB object store is `neighbor_graph` (DB_VERSION=3). The divergence entries below are preserved as historical record. |
There was a problem hiding this comment.
@copilot This document is now outdated and presents an information hazard. Just delete it. It was missed in a previous pass over the docs and popped up here.
There was a problem hiding this comment.
Deleted ARCHITECTURE-REVIEW.md and removed its entry from the README key documents table. No references to it remain. Commit: e0601d6.
Co-authored-by: devlux76 <86517969+devlux76@users.noreply.github.com>
Co-authored-by: devlux76 <86517969+devlux76@users.noreply.github.com>
…e its README reference Co-authored-by: devlux76 <86517969+devlux76@users.noreply.github.com>
The term "Metroid" was incorrectly used throughout code and docs to name the sparse proximity/neighbor graph (
MetroidNeighbor,MetroidSubgraph,metroid_neighbors). In CORTEX, "Metroid" is reserved for the{ m1, m2, c }dialectical search probe — a distinct concept that must not collide with proximity graph naming.The TypeScript sources (
core/types.ts,storage/IndexedDbMetadataStore.ts,cortex/Query.ts, tests) were already renamed in a prior pass. This PR closes out the remaining documentation and tracking debt.docs/api.mdMetroidNeighbor→SemanticNeighbor,MetroidSubgraph→SemanticNeighborSubgraphMetadataStoreproximity graph methods updated to correct names (putSemanticNeighbors,getSemanticNeighbors,getInducedNeighborSubgraph,needsNeighborRecalc,flagVolumeForNeighborRecalc,clearNeighborRecalcFlag)core/types.tsREADME.mdARCHITECTURE-REVIEW.mdentry from the key documents tableDESIGN.mdPLAN.mdFullNeighborRecalcrowTODO.md- [x])ARCHITECTURE-REVIEW.mdOriginal prompt
🔒 GitHub Advanced Security automatically protects Copilot coding agent pull requests. You can protect all pull requests by enabling Advanced Security for your repositories. Learn more about Advanced Security.