Files
create/docs/OVERVIEW.md
forbes 7f02fd182e
All checks were successful
Build and Test / build (pull_request) Successful in 24m46s
docs: comprehensive documentation refresh — remove stale references, add missing content
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
2026-03-03 13:52:53 -06:00

2.1 KiB

Kindred Create

Last updated: 2026-03-02 Branch: main @ b0621f9731c Kindred Create: v0.1.5 FreeCAD base: v1.2.0

Documentation

Document Contents
ARCHITECTURE.md Bootstrap flow, source layout, submodules
COMPONENTS.md Silo, Gears, Origin commands, theme, icons
INTEGRATION_PLAN.md Architecture layers, integration phases
CI_CD.md Build and release workflows
INTER_SOLVER.md Inter-solver communication
DAG_CLIENT_INTEGRATION.md DAG client integration (draft)
BOM_MERGE.md Bill of materials merge specification
KC_SPECIFICATION.md .kc file format specification

Submodules

Submodule Path Source Pinned commit
silo-mod mods/silo git.kindred-systems.com/kindred/silo-mod cc6a79f
gears mods/gears git.kindred-systems.com/kindred/gears 1e26c39
datums mods/datums git.kindred-systems.com/kindred/datums
solver mods/solver git.kindred-systems.com/kindred/solver cd7f66f
OndselSolver src/3rdParty/OndselSolver git.kindred-systems.com/kindred/solver fe41fa3
GSL src/3rdParty/GSL github.com/microsoft/GSL 756c91a
AddonManager src/Mod/AddonManager github.com/FreeCAD/AddonManager 01e242e
googletest tests/lib github.com/google/googletest 56efe39

The silo submodule was split from a monorepo into three repos: silo-client (shared Python API client), silo-mod (FreeCAD workbench, used as Create's submodule), and silo-calc (LibreOffice Calc extension). The silo-mod repo includes silo-client as its own submodule.

OndselSolver is forked from github.com/FreeCAD/OndselSolver to carry a Newton-Raphson convergence fix.

The ztools addon was removed from the build (#344) and archived to reference/ztools/ (#345) as part of the UI/UX rework (#346). Its commands will be reimplemented through the KCSDK system.