docs: remove stale documentation and update for post-ztools architecture #369

forbes · 2026-03-02T18:28:41Z

forbes commented

2026-03-02 18:28:41 +00:00

Summary

Removes critically stale documentation and rewrites moderately stale docs to reflect the current post-ztools architecture.

Removed (critically stale)

docs/REPOSITORY_STATE.md — snapshot from 2026-01-31, all submodule SHAs and phase statuses wrong
docs/MULTI_USER_CLIENT.md — exact duplicate of DAG_CLIENT_INTEGRATION.md
docs/src/guide/ztools.md — described removed addon as active workbench
docs/KNOWN_ISSUES.md — superseded by Gitea issue tracker

Rewritten (moderately stale)

docs/OVERVIEW.md — updated version (v0.1.5), FreeCAD base (1.2.0), submodule table, removed KNOWN_ISSUES link
docs/COMPONENTS.md — removed ztools section, added gears section, removed stale missing-icons note
docs/ARCHITECTURE.md — replaced ztools with gears in bootstrap flow, source layout, load order
docs/INTEGRATION_PLAN.md — marked Phase 7 #353-#356 as DONE, updated Layer 5, removed ztools refs
README.md — updated project structure, load order, feature descriptions, removed ztools usage section
docs/CI_CD.md — added context for disabled macOS/Windows builds
docs/src/SUMMARY.md — removed ztools guide from mdBook nav

## Summary Removes critically stale documentation and rewrites moderately stale docs to reflect the current post-ztools architecture. ### Removed (critically stale) - `docs/REPOSITORY_STATE.md` — snapshot from 2026-01-31, all submodule SHAs and phase statuses wrong - `docs/MULTI_USER_CLIENT.md` — exact duplicate of DAG_CLIENT_INTEGRATION.md - `docs/src/guide/ztools.md` — described removed addon as active workbench - `docs/KNOWN_ISSUES.md` — superseded by Gitea issue tracker ### Rewritten (moderately stale) - `docs/OVERVIEW.md` — updated version (v0.1.5), FreeCAD base (1.2.0), submodule table, removed KNOWN_ISSUES link - `docs/COMPONENTS.md` — removed ztools section, added gears section, removed stale missing-icons note - `docs/ARCHITECTURE.md` — replaced ztools with gears in bootstrap flow, source layout, load order - `docs/INTEGRATION_PLAN.md` — marked Phase 7 #353-#356 as DONE, updated Layer 5, removed ztools refs - `README.md` — updated project structure, load order, feature descriptions, removed ztools usage section - `docs/CI_CD.md` — added context for disabled macOS/Windows builds - `docs/src/SUMMARY.md` — removed ztools guide from mdBook nav

forbes added 1 commit 2026-03-02 18:28:42 +00:00

docs: remove stale documentation and update for post-ztools architecture

Build and Test / build (pull_request) Successful in 28m56s

Details

de1b79255c

Remove critically stale docs:
- docs/REPOSITORY_STATE.md — snapshot from 2026-01-31, all data outdated
- docs/MULTI_USER_CLIENT.md — duplicate of DAG_CLIENT_INTEGRATION.md
- docs/src/guide/ztools.md — describes removed addon
- docs/KNOWN_ISSUES.md — replaced by Gitea issue tracker

Update docs for ztools removal (#344), gears addition, and KCSDK progress:
- OVERVIEW.md: fix version (v0.1.5), FreeCAD base (1.2.0), submodule table
- ARCHITECTURE.md: replace ztools with gears in bootstrap flow and source layout
- COMPONENTS.md: remove ztools section, add gears, remove stale missing-icons note
- INTEGRATION_PLAN.md: mark Phase 7 #353-#356 as DONE, update Layer 5 diagram
- README.md: update project structure, load order, feature descriptions
- CI_CD.md: add context for disabled macOS/Windows builds (#164)
- SUMMARY.md: remove ztools guide from mdBook navigation

forbes merged commit 177a5eec67 into main

2026-03-02 19:03:52 +00:00

forbes deleted branch docs/stale-doc-cleanup

2026-03-02 19:03:52 +00:00

forbes referenced this issue from a commit

2026-03-02 19:03:52 +00:00

Merge pull request 'docs: remove stale documentation and update for post-ztools architecture' (#369) from docs/stale-doc-cleanup into main

Sign in to join this conversation.

1 Participants

Notifications

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: kindred/create#369