Skip to content

Commit d87bf15

Browse files
authored
docs(super-editor): drop dangling @see plans/unified-history.md references (SD-2923) (#3111)
The design doc at plans/unified-history.md does not exist in the repo and was never committed. Six @see references pointed at it across the presentation-editor history coordinator. The surrounding comments already carry the design rationale inline (participant model, batch adapter purpose, kill-switch fallback path), so removing the dead cross-references is the lowest-risk fix. In history/types.ts the dead "see X" line introduced an inline summary that is still valid; replaced the prefix with "Design at a glance:" so the bullets stay anchored. In PresentationEditor.ts:5335 the dead prefix was inline in a paragraph; dropped it and let the surrounding sentence reflow. The other four occurrences were standalone @see lines deleted outright. If the design doc resurfaces, add a real path back. Until then a broken cross-reference is actively harmful per the comment policy ("treat stale comments and stale agent-facing docs as bugs").
1 parent 0ab9966 commit d87bf15

5 files changed

Lines changed: 3 additions & 10 deletions

File tree

packages/super-editor/src/editors/v1/core/presentation-editor/PresentationEditor.ts

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1648,8 +1648,6 @@ export class PresentationEditor extends EventEmitter {
16481648
* them safe to run multiple times.
16491649
*
16501650
* No-op when unified history is disabled.
1651-
*
1652-
* @see plans/unified-history.md § Phase 4
16531651
*/
16541652
recordHistoryBatch(batch: BatchHistoryRecord): void {
16551653
this.#historyCoordinator?.withHistoryBatch(batch);
@@ -5332,8 +5330,8 @@ export class PresentationEditor extends EventEmitter {
53325330
// ===========================================================================
53335331
// Unified History Coordinator (enabled by default; explicit false disables)
53345332
//
5335-
// See plans/unified-history.md. When the kill-switch is off, these helpers are
5336-
// no-ops so the legacy active-editor-first routing stays intact.
5333+
// When the kill-switch is off, these helpers are no-ops so the legacy
5334+
// active-editor-first routing stays intact.
53375335
// ===========================================================================
53385336

53395337
#isUnifiedHistoryEnabled(): boolean {

packages/super-editor/src/editors/v1/core/presentation-editor/history/NoteEditorRegistry.ts

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,6 @@
1414
* entries in lockstep.
1515
* - Idle disposal policy lives here (a story runtime cache miss should not
1616
* kill an editor the coordinator still references).
17-
*
18-
* See `plans/unified-history.md`, Phase 2.
1917
*/
2018

2119
import type { FootnoteStoryLocator, EndnoteStoryLocator } from '@superdoc/document-api';

packages/super-editor/src/editors/v1/core/presentation-editor/history/batch-history-adapter.ts

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,6 @@
1010
* Each `withHistoryBatch()` call pushes one batch record here. The batch's
1111
* `undo` / `redo` callbacks are what the coordinator actually runs when it
1212
* reaches this adapter during replay — there is no underlying editor step.
13-
*
14-
* See `plans/unified-history.md`, Phase 4.
1513
*/
1614

1715
import type { HistorySnapshotAdapter, ParticipantHistorySnapshot } from './types.js';

packages/super-editor/src/editors/v1/core/presentation-editor/history/types.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
/**
22
* Shared types for the unified document-wide history coordinator.
33
*
4-
* See `plans/unified-history.md` for the full design rationale. At a glance:
4+
* Design at a glance:
55
* - Each editable surface (body, header/footer, …) registers as a
66
* `HistoryParticipant` with its own local PM/Yjs history engine.
77
* - The coordinator observes local history snapshots and maintains a global

packages/super-editor/src/editors/v1/core/presentation-editor/types.ts

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -224,7 +224,6 @@ export type PresentationEditorOptions = ConstructorParameters<typeof Editor>[0]
224224
* active-surface undo routing.
225225
*
226226
* @default true
227-
* @see plans/unified-history.md
228227
*/
229228
unifiedHistory?: boolean;
230229
};

0 commit comments

Comments
 (0)