Files

Build and Test / build (pull_request) Successful in 24m46s

Details

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

1.4 KiB

Raw Permalink Blame History

Known Issues

Last updated: 2026-03-03

Silo

Auth not production-hardened -- LDAP/OIDC backends are coded but need infrastructure deployment. Currently only local (bcrypt) auth is tested in production.
No unit tests for Silo FreeCAD commands or Go backend.
Silo_BOM requires Silo-tracked document -- Unregistered documents show a warning with no inline registration path.

Assembly

Solver datum handling is minimal -- Joints referencing datum planes/points may produce incorrect placement. The Kindred fork carries patches to findPlacement() for PartDesign::Plane, PartDesign::Point, App::Plane, and App::Point, but coverage is incomplete for complex assemblies.

Theme

QSS edits -- Only edit src/Gui/Stylesheets/KindredCreate.qss. The PreferencePacks copy at src/Gui/PreferencePacks/KindredCreate/KindredCreate.qss is generated at build time via configure_file().

Platform

CI/CD is Linux x86_64 only -- macOS and Windows build presets are defined but no CI runners are configured.
Wayland fractional scaling -- Some HiDPI scaling issues remain on Wayland with fractional scaling factors.

Archived Addons

ztools and QuickNav archived -- These addons are in reference/ztools/ and reference/quicknav/ for reference only. They are not built or loaded. ZTools commands are being reimplemented through the KCSDK system and the datums addon.

1.4 KiB Raw Permalink Blame History

Known Issues

Silo

Assembly

Theme

Platform

Archived Addons

1.4 KiB

Raw Permalink Blame History