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.7 KiB

Raw Blame History

Contributing

Kindred Create is maintained at git.kindred-systems.com/kindred/create. Contributions are submitted as pull requests against the main branch.

Getting started

git clone --recursive ssh://git@git.kindred-systems.com:2222/kindred/create.git
cd create
pixi run configure
pixi run build
pixi run freecad

See Building from Source for the full development setup.

Branch and PR workflow

Create a feature branch from main:
```
git checkout -b feat/my-feature main
```
Make your changes, commit with conventional commit messages (see below).
Push and open a pull request against main.
CI builds and tests run automatically on all PRs.

Commit messages

Use Conventional Commits:

Prefix	Purpose
`feat:`	New feature
`fix:`	Bug fix
`chore:`	Maintenance, dependencies
`docs:`	Documentation only
`art:`	Icons, theme, visual assets

Scope is optional but encouraged:

feat(datums): add datum point creation mode
fix(gui): correct menu icon size on Wayland
chore: update silo submodule

Reporting issues

Report issues at the issue tracker. When reporting:

Note whether the issue involves Kindred Create additions (Silo, Gears, Datums, theme) or base FreeCAD
Include version info from Help > About FreeCAD > Copy to clipboard
Provide reproduction steps and attach example files (FCStd as ZIP) if applicable

For base FreeCAD issues, also check the FreeCAD issue tracker.

1.7 KiB Raw Blame History