kindred/create
1
1
Fork 0
Code Issues 53 Pull Requests Actions Packages Projects 9 Releases 2 Wiki Activity

docs: comprehensive documentation refresh #379

Merged
forbes merged 1 commits from docs/user-docs-refresh into main 2026-03-03 19:56:17 +00:00
Conversation 0 Commits 1 Files Changed 20 +247 -155
forbes commented 2026-03-03 19:53:23 +00:00
Owner
Copy Link

Removes stale ztools/QuickNav references, adds missing content for datums/gears/solver addons, and fixes dead links across 20 documentation files.

Summary of changes

Root documentation

  • README.md: Add Datums description, update addon load order (sdk→solver→gears→datums→silo), fix project structure tree, update SDK references
  • CONTRIBUTING.md: Update submodule table (remove ztools, add gears/datums/solver), fix QSS guidance (single canonical source, not three copies)
  • docs/ARCHITECTURE.md: Update bootstrap flow with all 5 addons, split deferred timer documentation between Create core and Silo addon, update source layout
  • docs/COMPONENTS.md: Add Datums and Solver sections, update Gears description, fix Silo origin registration reference
  • docs/KNOWN_ISSUES.md: Create this file (was referenced by CLAUDE.md and CONTRIBUTING.md but didn't exist)
  • docs/INTEGRATION_PLAN.md: Update layer 5 diagram with all addons, fix load order, update Phase 6 install rules
  • docs/OVERVIEW.md: Add datums submodule entry
  • docs/UPSTREAM.md: Update Phase 1 directory table and Phase 4 submodule list

mdBook documentation (docs/src/)

  • SUMMARY.md: Replace 5 dead architecture/ links with existing reference pages, remove 2 deleted silo-server files, add 3 new silo-server pages
  • introduction.md: Full rewrite — replace ztools with current features (Silo, Gears, Datums, KCSDK), update version
  • guide/workbenches.md: Full rewrite — replace ztools section with Gears, Datums, Solver
  • reference/create-module-bootstrap.md: Full rewrite — reflect addon_loader system, split deferred timers
  • reference/datum-creator.md: Update from ZTools to datums addon paths and naming
  • reference/glossary.md: Add KCSDK entry, update FreeCAD version, remove ztools, update repo URLs
  • guide/getting-started.md, installation.md, building.md: Update addon references and submodule tables
  • development/contributing.md, repo-structure.md, writing-an-addon.md: Fix stale references

Follows #378 (CLAUDE.md update). Part of the documentation refresh for the repo cleanup milestone.

Removes stale ztools/QuickNav references, adds missing content for datums/gears/solver addons, and fixes dead links across 20 documentation files. ## Summary of changes ### Root documentation - **README.md**: Add Datums description, update addon load order (sdk→solver→gears→datums→silo), fix project structure tree, update SDK references - **CONTRIBUTING.md**: Update submodule table (remove ztools, add gears/datums/solver), fix QSS guidance (single canonical source, not three copies) - **docs/ARCHITECTURE.md**: Update bootstrap flow with all 5 addons, split deferred timer documentation between Create core and Silo addon, update source layout - **docs/COMPONENTS.md**: Add Datums and Solver sections, update Gears description, fix Silo origin registration reference - **docs/KNOWN_ISSUES.md**: Create this file (was referenced by CLAUDE.md and CONTRIBUTING.md but didn't exist) - **docs/INTEGRATION_PLAN.md**: Update layer 5 diagram with all addons, fix load order, update Phase 6 install rules - **docs/OVERVIEW.md**: Add datums submodule entry - **docs/UPSTREAM.md**: Update Phase 1 directory table and Phase 4 submodule list ### mdBook documentation (docs/src/) - **SUMMARY.md**: Replace 5 dead architecture/ links with existing reference pages, remove 2 deleted silo-server files, add 3 new silo-server pages - **introduction.md**: Full rewrite — replace ztools with current features (Silo, Gears, Datums, KCSDK), update version - **guide/workbenches.md**: Full rewrite — replace ztools section with Gears, Datums, Solver - **reference/create-module-bootstrap.md**: Full rewrite — reflect addon_loader system, split deferred timers - **reference/datum-creator.md**: Update from ZTools to datums addon paths and naming - **reference/glossary.md**: Add KCSDK entry, update FreeCAD version, remove ztools, update repo URLs - **guide/getting-started.md, installation.md, building.md**: Update addon references and submodule tables - **development/contributing.md, repo-structure.md, writing-an-addon.md**: Fix stale references Follows #378 (CLAUDE.md update). Part of the documentation refresh for the repo cleanup milestone.
forbes added 1 commit 2026-03-03 19:53:24 +00:00
docs: comprehensive documentation refresh — remove stale references, add missing content
All checks were successful
Build and Test / build (pull_request) Successful in 24m46s
Details
7f02fd182e 
Root documentation:
- README.md: add Datums description, update addon load order and SDK references,
  fix project structure tree, update issue reporting guidance
- CONTRIBUTING.md: update submodule table (remove ztools, add gears/datums/solver),
  fix QSS guidance (single canonical source, not three copies)
- docs/ARCHITECTURE.md: update bootstrap flow (5 addons, split deferred timers
  between Create core and Silo addon), update load order and source layout
- docs/COMPONENTS.md: add Datums and Solver sections, update Gears description,
  fix Silo origin registration reference
- docs/KNOWN_ISSUES.md: create missing file referenced by CLAUDE.md and CONTRIBUTING.md
- docs/INTEGRATION_PLAN.md: update layer 5 diagram, fix load order references,
  update Phase 6 install rules, fix Layer 2/3/5 descriptions
- docs/OVERVIEW.md: add datums submodule entry
- docs/UPSTREAM.md: update Phase 1 directory table and Phase 4 submodule list

mdBook documentation (docs/src/):
- SUMMARY.md: replace dead architecture/ links with existing reference pages,
  remove deleted silo-server files, add new silo-server pages
- introduction.md: rewrite — replace ztools with current addons (Silo, Gears,
  Datums, KCSDK), update version to v0.1.5/FreeCAD 1.2.0
- guide/getting-started.md: update first-run addon list
- guide/installation.md: update verification console output
- guide/workbenches.md: rewrite — replace ztools with Gears, Datums, Solver
- guide/building.md: update submodule table, fix error message guidance
- development/contributing.md: fix scope example and issue reporting
- development/repo-structure.md: rewrite — add SDK, datums, gears, solver,
  reference/ folder; update submodule and key files tables
- development/writing-an-addon.md: fix priority range table
- reference/create-module-bootstrap.md: rewrite — reflect addon_loader system,
  split deferred timers between Create core and Silo addon
- reference/datum-creator.md: update from ZTools to datums addon paths and naming
- reference/glossary.md: add KCSDK entry, update FreeCAD version, remove ztools
  entry, update repository URLs table
forbes merged commit d84049b905 into main 2026-03-03 19:56:17 +00:00
forbes deleted branch docs/user-docs-refresh 2026-03-03 19:56:17 +00:00
Sign in to join this conversation.
Reviewers
No Reviewers
Labels
Clear labels
UX
branding
bug
ci/cd
CI/CD workflows and deployment
 defaults
documentation
Developer documentation
 enhancement
high-priority
low-priority
theme
No Label
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
forbes
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: kindred/create#379
Delete Branch "docs/user-docs-refresh"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?