Skip to content

Commit 4112142

Browse files
authored
docs: retire internal research artifacts and consolidate docs (#3935)
* docs: retire internal research artifacts and consolidate docs (#3926) * docs: address cleanup review findings (#3926)
1 parent a94a4bb commit 4112142

234 files changed

Lines changed: 265 additions & 57885 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

.github/workflows/moonshot.yml

Lines changed: 0 additions & 521 deletions
This file was deleted.

.github/workflows/xmatch-fixture.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@
4040
# COST. Deliberately cheap and non-blocking; it MUST NOT become a required
4141
# check:
4242
# - weekly `schedule` + on-demand `workflow_dispatch`, the same profile as
43-
# determinism.yml / wide-arithmetic.yml / moonshot.yml;
43+
# determinism.yml / wide-arithmetic.yml;
4444
# - `push`/`pull_request` ONLY on the paths that can invalidate the result:
4545
# the diff engine, the geometry kernel and the wasm bundle it is measured
4646
# through, the CLI adapter that builds the fingerprints, and the harness

CONTRIBUTING.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,24 @@ of published `@ifc-lite/*` packages plus a CLI, MCP server, and HTTP server.
88
conventions ("house rules"). Read it before a non-trivial change. This file is
99
the short version for getting set up and opening a PR.
1010

11+
## Documentation
12+
13+
Keep committed documentation durable and owned by the code it describes:
14+
15+
- `docs/guide` and `docs/tutorials` explain current user workflows.
16+
- `docs/architecture` records current system boundaries and design constraints.
17+
- `docs/contributing` contains active contributor and release procedures.
18+
- A versioned compatibility contract belongs beside its owning package as
19+
`SPEC.md`.
20+
- Planned work belongs in an issue or project, not a checked-in task tracker.
21+
- Generated benchmark output and investigation transcripts belong in CI
22+
artifacts or the originating issue. Git history is the archive; do not add
23+
an `archive`, `research-notes`, or completed-plan directory.
24+
25+
Every page under `docs/` must appear in `mkdocs.yml`. Run `pnpm docs:build`,
26+
`pnpm docs:check-samples`, and `pnpm docs:check-generated` for documentation
27+
changes.
28+
1129
## Setup
1230

1331
```bash

ORCHESTRATION.md

Lines changed: 0 additions & 21 deletions
This file was deleted.

apps/viewer/src/components/viewer/ClashBcfExportDialog.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
/**
66
* "Export to BCF" dialog for clash results.
77
*
8-
* The headline requirement (see docs/architecture/clash-detection-plan.md §6) is
8+
* The headline requirement (see docs/architecture/clash-detection.md §6) is
99
* a *manageable* BCF: 1,000 clashes must never become 1,000 topics. This dialog
1010
* puts that control in the user's hands — choose how clashes collapse into
1111
* topics, filter by severity, cap the count, pick the initial status, and

apps/viewer/src/store/slices/collabSlice.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
* Owns the live `CollabSession`, the local ephemeral identity, the resolved
99
* access role, and the presence roster. This is the viewer-side counterpart
1010
* to `@ifc-lite/collab`; see `docs/guide/collaboration.md` for the feature and
11-
* `docs/architecture/collab-plan.md` for the design.
11+
* `docs/architecture/collaboration.md` for the design.
1212
*
1313
* What this scaffolding wires up today:
1414
* - identity bootstrap (accountless, persisted handle + color),

apps/viewer/src/store/slices/splitToolSlice.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
* cut distance, click commits via `MutationSlice.splitWallAtDistance`.
1111
*
1212
* Bigger surface (slab cut-line, multi-element plane split, beam /
13-
* column / member) is in `docs/design/element-splitting.md` and
13+
* column / member) is in `docs/architecture/element-splitting.md` and
1414
* arrives in subsequent phases. The slice is shaped to grow without
1515
* a breaking rename — `splitMode` covers the future modes;
1616
* `splitHoverPoint` and `splitTargetExpressId` will be reused.

0 commit comments

Comments
 (0)