Skip to content

docs: calibrate specs/ to codebase truth (31 files, index restructure) - #350

Merged
btspoony merged 12 commits into
mainfrom
docs/specs-truth-maintenance
Sep 29, 2026
Merged

btspoony merged 12 commits into
mainfrom
docs/specs-truth-maintenance

Conversation

@auto-wood

Copy link
Copy Markdown
Contributor

Summary

Docs-maintenance round 2026-09-29-specs-truth-maintenance: 16 read-only audit seats verified all 65 spec files against the codebase (code = ground truth); 24 drift files fixed across 9 commits by serial single-writer architect waves; specs/README.md + root AGENTS.md indexes restructured.

Key corrections

  • Retired topologies explicitly historicized: local-cloud-crate-architecture → historical crate-graph record; local-runtime-boundary daemon host sections historical; current owners = apps/nexus-service (serves /v1/daemon/*), Electron desktop, nexus-runtime Connect host
  • creator-run-preset-entry → retired runner record (v1.193 P2-T1, no replacement preset dispatch); creator-workflow auto-chain/resume-chain retired
  • entity-scope-model BlockType enum synced to the 19-value wire enum (incl. era); dead nexus-kb anchors → nexus-knowledge
  • ACP SDK pin 2.1.0 → =2.2.0; capability roster recounted (30 static IDs = 28 nexus.* + 2 fs/*); capability-registry Master/Draft ambiguity resolved
  • llm-extract: production preset routing marked unshipped (review-time pathway only); preset-conditional-routing → shipped normative SSOT framing
  • novel-writing/sync-contract: shipped-library status with real owner (crates/nexus-orchestration/src/sync_module.rs); StoryBundle cloud transport explicitly unwired; V1.36 historical contract preserved
  • specs/README.md two-way index/disk diff empty (62/62); 108 links resolve; root AGENTS.md +7 subdirectory rows; 4 missing Document class declarations added

Verification

  • Single-seat QC: initial Reject (1 Warning: historical sync-contract content rewritten) → targeted fix 84e00ae76 → re-review Approve, findings [] (.mstar/sdd/2026-09-29-specs-truth-maintenance/review/qc-consolidated.md)
  • PM acceptance recorded (docs-only tier, no runtime diff); per-wave before/after evidence with re-verified code anchors
  • Code residual registered (not fixed here): R-DOCS-001 — concurrency.md §6.2 successful-acquire stale-holder detection missing in crates/nexus-local-db/src/file_lock.rs::try_acquire (medium, open)

Non-goals

No code/schema/CLI changes; no directory sharding of specs/ (flat layout is canon).

@greptile-apps

greptile-apps Bot commented Sep 29, 2026 •

Copy link
Copy Markdown
Contributor

RetriggerConfidence Score: 5/5

[Low risk] Documentation restructure and cross-reference updates.

The latest change appears safe to merge, though two documentation findings from the previous review remain open.

Fix All in CursorFindings

  1. P2 Conflicting refresh registration guidance ▶
  2. P2 Stale authoritative design reference ▶
Fix with agent prompt
### Issue 1
.mstar/specs/runtime/reference-knowledge.md:185-187
This new integration note correctly says `nexus.reference.refresh` is registered in the core tool table, but §5 still says it is not registered in `host_tool_registry()` or exposed as a host tool. The core registry registers it as a writable host tool. Readers therefore get conflicting guidance about whether they can dispatch the capability. Please reconcile §5 with the registration, while keeping the separate point that the periodic scheduler is not started.

Note: If this suggestion doesn't match your team's coding style, reply to this and let me know. I'll remember it for next time!

### Issue 2
.mstar/specs/orchestration/orchestration-engine.md:undefined-5
Moving this spec into `specs/orchestration/` leaves the `nexus-orchestration` crate’s “Authoritative design” comment pointing to the removed flat path. Contributors following it cannot reach the current spec. Please update that reference and the other source comments that still cite moved spec paths.

---

For each issue above, determine whether it is valid and should be fixed. If so, fix it directly.

Summary

The PR reconciles specs with current code ownership and reorganizes them into domain directories. Since the previous review, the only change corrects an external-consumer spec link in docs/ARCHITECTURE.md.

Reviews (4) · Last reviewed commit: "docs: fix stale knowledge-path link to s..."

Comment thread .mstar/specs/runtime/reference-knowledge.md
Comment thread .mstar/specs/agents/acp-client-tech-spec.md
…istorical

External-review fixes on PR #350:

- reference-knowledge.md: distinguish retained implementation from running
  service — spawn_refresh_scheduler has zero call sites in crates/ + apps/
  (daemon boot path deleted v1.193 P2) and no production caller invokes
  nexus.reference.refresh; registered sources do not refresh automatically
  today. Retarget stale 'daemon-side' / 'daemon runtime (periodic task)'
  anchors and the §5 'in production' pool-dependency clause.
- acp-client-tech-spec.md: Appendix B quote-note no longer presents
  acp-worker children as current; framing fully historical (retired
  v1.193 P2, current composition per the shipped boundary in the header).
Comment thread .mstar/specs/runtime/reference-knowledge.md
greptile-apps[bot]
greptile-apps Bot previously approved these changes Sep 29, 2026
Maintainer-authorized 2026-09-29 (round 2026-09-29-specs-truth-maintenance):

- git mv 52 root specs into 10 new dirs: architecture(9), runtime(8),
  compute(2), cli(1), orchestration(4), agents(6), creator(7),
  surfaces(5), contracts(3), archived(7); novel-writing/ unchanged;
  specs/ root keeps only README.md + AGENTS.md
- migrate every inbound link: 640 link targets rewritten inside specs/**,
  210 path occurrences across 48 external files (knowledge/, root
  AGENTS/DESIGN/CONCEPTS/STRATEGY, docs/, apps+crates+packages AGENTS.md,
  modules/README.md)
- retarget findings-lifecycle's redirect-stub link to
  daemon-api-surface-conventions §11 (findings PATCH route) before
  archiving the stub; retarget its dead daemon-handler link to the
  current core service home (crates/nexus-core/src/findings.rs)
- fix 5 pre-existing stale anchors surfaced by the 100% link gate:
  creator-workflow §8 (v147-shipped), author-experience §4.6 (F###/E###),
  orchestration-engine TOC §11, web-ui Entrance -> CONCEPTS.md#entrance,
  apps/design-studio/AGENTS.md §2 (audiences-and-contributor-jobs)
- rewrite specs/README.md (taxonomy layout section, regrouped master
  index, archived/ records section; two-way index/disk coverage 62/62)
  and specs/AGENTS.md (domain-subdir convention + archived/ policy +
  maintainer authorization date 2026-09-29)
- verification: 899 specs/** relative links + 47 knowledge spec-links +
  50 root AGENTS.md links + 115 other external spec-links all resolve
  (files and anchors); specs/ root = README + AGENTS + 11 dirs only
Comment thread .mstar/specs/orchestration/orchestration-engine.md
greptile-apps[bot]
greptile-apps Bot previously approved these changes Sep 29, 2026
…dary

QC repair on top of a650cfe: docs/ARCHITECTURE.md:58 still pointed at
.mstar/knowledge/schemas-external-consumer-boundary.md — the file moved
from the knowledge root to specs on 2026-08-17 and now lives at
.mstar/specs/architecture/schemas-external-consumer-boundary.md (post-
reorg path). Repointed display text + target; verified the link
resolves. Swept the file (and the full touched external surface) for
the same stale .mstar/knowledge/ spec pattern: this was the only
instance — 127 .mstar-target links in the external surface now 100%
resolve; four migration gates re-verified PASS.
@btspoony
btspoony merged commit 3f4c7d0 into main Sep 29, 2026
28 checks passed
@btspoony
btspoony deleted the docs/specs-truth-maintenance branch September 29, 2026 14:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants