Skip to content

chore(public): retire historical docs, estate references and compat framing - #494

Merged
thedancingdeveloper merged 1 commit into
devfrom
feat/opensource-cleanup
Sep 1, 2026
Merged

chore(public): retire historical docs, estate references and compat framing#494
thedancingdeveloper merged 1 commit into
devfrom
feat/opensource-cleanup

Conversation

@thedancingdeveloper

Copy link
Copy Markdown
Contributor

Prepares the public tree as an open-source project that documents only its current state. 30 files, +248/−3566.

What changed

  • Historical design/workplan docs retired. COMPARE, DEMO_SITE_PLAN, FORGE_FRONTEND_DESIGN (self-marked for deletion once forge-frontend (e): native-item migration on link + forge-less guarantee withdrawal (#178) #183 closed), IMPORT-PLAYBOOK, VOICE_POC, VOICE_DELIVERY, and the M0–M14 delivery-record ROADMAP leave the tree (archived in the operator's git-ignored docs/local/attic/). ROADMAP.md is rewritten as a short current-state roadmap — designed-but-unbuilt, pending cleanup, deliberate deferrals — since AGENTS.md, the PR/issue templates and CONTRIBUTING rely on it as a convention.
  • opensource.md removed, no successor. With no released users there is no compatibility contract to publish. The legacy MYDEVENV2_* names become pending housekeeping in ROADMAP.md instead of documented aliases, and CONTRIBUTING now forbids adding new compat aliases. (Code-level alias removal is a separate, larger task — ~70 files.)
  • Delivery narration trimmed from the keeper docs. DESIGN.md (revision/date header, milestone and r-number references, stale buildless-GUI layer entry, the dated open-questions log — now "Standing decisions" — and §11 generalised away from a private product), SCHEMA.md (r2–r5 preamble), ENGINE.md, USER_GUIDE.md, CUSTOMISATION.md, DEPLOYMENT.md.
  • *.sprooty.com scrubbed from tracked files (ci.yml comment, capacitor.config.ts, smoke_merged_stack.sh usage, identity.py docstring, test_connect.py fixtures). The test_public_delivery.py ESTATE_MARKERS denylist keeps enforcing the rule and is untouched.
  • scripts/pin_estate_image.py dropped (+ its test) — orphaned; its consumer lives in the private ops repository. test_mobile_identity.py loses only the assertion that guarded claims inside the removed VOICE_POC.md.
  • AI_POLICY.md added at the root and linked from README: this stack is written by AI agents, for AI-forward developers — provenance, contributor accountability, and where human decisions stay.

Deliberately left in place

deploy_dev.py, fetch_infisical_secret.sh, write_firebase_config.sh and the estate workflows (deploy-*, ghcr-retention, mirror-base-images, pod-base, promote*) are load-bearing for the live pipelines; relocating them to the private ops repository is a separate decision. .github/ must stay tracked for CI to exist.

Verification

  • uv run pytest — 1296 passed, 25 skipped
  • uv run mypy — clean (210 files)
  • uv run ruff check / ruff format --check on touched Python
  • python scripts/check_docs.py — 30 markdown files, all relative links resolve

🤖 Generated with Claude Code

https://claude.ai/code/session_0161etTkUPyRoUXnHQ8xgKUu

…raming

Prepare the public tree as an open-source project that documents only its
current state:

- Move completed design/workplan records (COMPARE, DEMO_SITE_PLAN,
  FORGE_FRONTEND_DESIGN, IMPORT-PLAYBOOK, VOICE_POC, VOICE_DELIVERY, the
  M0-M14 ROADMAP) out of the tree; they survive in the operator's
  git-ignored docs/local/. ROADMAP.md is rewritten as a short current-state
  roadmap (designed-but-unbuilt, pending cleanup, deliberate deferrals).
- Remove opensource.md. With no released users there is no compatibility
  contract to publish; the legacy MYDEVENV2_* names become pending
  housekeeping (ROADMAP.md) instead of documented aliases, and CONTRIBUTING
  now forbids adding new ones.
- Trim delivery narration from DESIGN.md, SCHEMA.md, ENGINE.md,
  USER_GUIDE.md, CUSTOMISATION.md and DEPLOYMENT.md: revision/date
  preambles, milestone (M-number) and revision (r-number) references, the
  stale buildless-GUI layer entry, and the dated open-questions log (now
  "Standing decisions").
- Scrub *.sprooty.com and other estate hostnames from tracked files
  (ci.yml comment, capacitor.config.ts, smoke_merged_stack.sh usage,
  identity.py docstring, test_connect.py fixtures); the
  test_public_delivery.py denylist keeps enforcing the rule.
- Drop scripts/pin_estate_image.py (orphaned; its consumer lives in the
  private ops repository) and its test.
- Add AI_POLICY.md: this stack is written by AI agents for AI-forward
  developers, and what that means for use, contribution and maintenance.

Verified: uv run pytest (1296 passed, 25 skipped), mypy, ruff,
scripts/check_docs.py.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_0161etTkUPyRoUXnHQ8xgKUu
@thedancingdeveloper
thedancingdeveloper merged commit 9a43ab0 into dev Sep 1, 2026
15 checks passed
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.

1 participant