docs(git-sync): remove dangling references to the deleted git-sync-plan doc (PR #119 review)

The implementation spec docs/git-sync-plan.md was removed as completed, but ~44
code comments still cited it as "plan §N". Strip those citations (comments only),
keeping each comment grammatical. The vendored engine's own "SPEC §N" references
point at a different, still-present spec and are left untouched.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
This commit is contained in:
claude code agent 227
2026-06-24 01:11:04 +03:00
parent 0dbf85b129
commit cca0bfe306
20 changed files with 51 additions and 52 deletions

View File

@@ -1,8 +1,8 @@
/**
* The client seam (plan §3.1). Upstream `pull.ts`/`push.ts` reached into the
* The client seam. Upstream `pull.ts`/`push.ts` reached into the
* REST `DocmostClient` from the `docmost-client` package via `Pick<DocmostClient,
* ...>` subsets. That package is NOT vendored here (the gitmost server writes
* NATIVELY — through repositories + collab `openDirectConnection`, plan §3.2/§3.3),
* NATIVELY — through repositories + collab `openDirectConnection`),
* so the engine must depend on a narrow STRUCTURAL interface instead.
*
* `GitSyncClient` is that interface: the native datasource (server side, a later
@@ -106,7 +106,7 @@ export interface GitSyncClient {
/**
* Reparent a page (and optionally set its fractional-index `position`). The
* engine passes `position` UNDEFINED for now; the native impl computes a
* default between siblings (plan §3.2). Result is not inspected.
* default between siblings. Result is not inspected.
*/
movePage(
pageId: string,

View File

@@ -25,7 +25,7 @@
* (read-only: listSpaceTree + getPageJson). All git operations run against
* the vault repo (`cwd = vaultPath`), never the source repo (see ./git.ts).
*
* VENDORED into gitmost (plan §2.1/§3.1): the client seam is the native
* VENDORED into gitmost: the client seam is the native
* `GitSyncClient` (`Pick<GitSyncClient, ...>`), not the upstream REST
* `DocmostClient`; the upstream CLI `main()` entry point is dropped (the gitmost
* server drives the engine in-process). Engine LOGIC is byte-identical.

View File

@@ -22,7 +22,7 @@
* then calls `move_page` / `rename_page` (both for a reparent+retitle), or
* records a NO-OP for a cosmetic local-only file-path rename.
*
* VENDORED into gitmost (plan §2.1/§3.1): the client seam is the native
* VENDORED into gitmost: the client seam is the native
* `GitSyncClient` (`Pick<GitSyncClient, ...>`), not the upstream REST
* `DocmostClient`; the upstream CLI `main()` entry point is dropped (the gitmost
* server drives the engine in-process). Engine LOGIC is byte-identical.

View File

@@ -2,8 +2,8 @@
* Pure helpers extracted from the docmost-sync Phase-0 idempotency harness
* (`src/roundtrip.ts`). Only the IO-free comparison utilities are vendored —
* the CLI scaffold (`--fixture`/`--page`/`--corpus`, `loadSettings`, the
* `DocmostClient` live path and `process.exit`) is NOT vendored (plan §2.1:
* the roundtrip harness moves into the package's tests, not the engine).
* `DocmostClient` live path and `process.exit`) is NOT vendored (the roundtrip
* harness moves into the package's tests, not the engine).
*/
/**

View File

@@ -1,10 +1,10 @@
/**
* Engine settings (plan §2.1 / §7.2 — ADAPTED for vendoring).
* Engine settings (ADAPTED for vendoring).
*
* Upstream this module also loaded `.env` (`dotenv`) and bound `parseSettings`
* to `process.env` via a `loadSettings()` entry point. In gitmost the engine is
* driven IN-PROCESS by the NestJS server, which builds the `Settings` object
* from `EnvironmentService` (plan §7.2) — so the engine must NOT reach into
* from `EnvironmentService` — so the engine must NOT reach into
* `process.env` here. We therefore vendor ONLY:
* - the `Settings` type the engine consumes, and
* - `parseSettings(env)` as a PURE function (validate a raw env object -> typed

View File

@@ -1,7 +1,7 @@
/**
* Public surface of `@docmost/git-sync`.
*
* Phase A (plan §12.A) vendors only the PURE converter + pure engine modules
* Phase A vendors only the PURE converter + pure engine modules
* from docmost-sync. Server integration (GitmostDataSource, orchestrator,
* VaultGit, pull/push) is added in later steps.
*/
@@ -45,7 +45,7 @@ export type { PageMeta } from "./engine/stabilize";
export { bodyHash } from "./engine/loop-guard";
// IO engine (plan §2.1/§3.1): the client seam, the VaultGit git wrapper, the
// IO engine: the client seam, the VaultGit git wrapper, the
// pull (Docmost->FS) + push (FS->Docmost) planners/appliers, and the (pure)
// settings parser. The engine consumes the native `GitSyncClient` seam (server
// implements it) — the upstream REST `DocmostClient` is NOT vendored.

View File

@@ -8,7 +8,7 @@
*
* The REST client, websocket/collab write-path, auth-utils and page-lock from
* the upstream package are deliberately NOT vendored (the gitmost server writes
* natively — plan §2.2/§2.3).
* natively).
*/
export {
serializeDocmostMarkdown,

View File

@@ -7,7 +7,7 @@
* (`preprocessCallouts`, `bridgeTaskLists`). The collaboration/websocket
* write-path (Hocuspocus, Yjs, `ws`, `withPageLock`, `sanitizeForYjs`) that
* lives in the same upstream file is intentionally NOT vendored — the gitmost
* server writes page bodies natively through the collab gateway (plan §3.3).
* server writes page bodies natively through the collab gateway.
*/
import { generateJSON } from "@tiptap/html";
import { JSDOM } from "jsdom";