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

docs: write OVERVIEW.md — project identity, FreeCAD relationship, and business context #87

New Issue
Closed
opened 2026-02-09 13:45:21 +00:00 by forbes · 1 comment
forbes commented 2026-02-09 13:45:21 +00:00
Owner
Copy Link

Tier 1 — Entry Point

File: docs/OVERVIEW.md
Priority: Read first — orients new contributors before anything else

What this document should cover

  1. What is Kindred Create — a professional engineering-focused parametric 3D CAD platform built on FreeCAD 1.0+
  2. Relationship to FreeCAD — fork/distribution model; minimal core modifications, addons via submodules, graceful degradation if submodules are missing
  3. Business context — Kindred Systems, target audience (engineering teams), what differentiates Create from stock FreeCAD
  4. High-level feature summary:
    • ztools workbench — unified Part Design/Assembly/Sketcher interface, custom datum creation (16 modes), enhanced pocket, assembly patterns, spreadsheet formatting
    • Silo workbench — parts database with revision control, BOM, team collaboration (PostgreSQL + MinIO + Go server)
    • Catppuccin Mocha theme — dark theme applied application-wide
    • Origin system — pluggable file backends (local vs Silo), origin selector widget
    • Update checker — background Gitea releases API monitoring
  5. Version info — Kindred Create v0.1.0, FreeCAD base v1.0.0, LGPL-2.1-or-later license
  6. Repository URLs:
    • Main repo: https://git.kindred-systems.com/kindred/create
    • ztools: git.kindred-systems.com/forbes/ztools
    • silo-mod: git.kindred-systems.com/kindred/silo-mod
    • OndselSolver: git.kindred-systems.com/kindred/solver
  7. Link to other docs — reading order for the rest of the documentation suite

Key source files to reference

  • README.md (root) — existing project overview
  • pixi.toml — project metadata (name, version, description)
  • CMakeLists.txt — version constants (KINDRED_CREATE_VERSION, FREECAD_VERSION)
  • LICENSE — LGPL-2.1-or-later
  • src/App/Branding.cpp — branding implementation
  • resources/branding/kindred-logo.svg — logo asset

Replaces

The existing docs/OVERVIEW.md is a brief auto-generated index. This issue calls for a proper narrative document.

Acceptance criteria

  • Document is self-contained enough that a new contributor understands what Create is without reading anything else
  • All repository URLs are correct and up to date
  • Reading order for remaining docs is clear
## Tier 1 — Entry Point **File:** `docs/OVERVIEW.md` **Priority:** Read first — orients new contributors before anything else ### What this document should cover 1. **What is Kindred Create** — a professional engineering-focused parametric 3D CAD platform built on FreeCAD 1.0+ 2. **Relationship to FreeCAD** — fork/distribution model; minimal core modifications, addons via submodules, graceful degradation if submodules are missing 3. **Business context** — Kindred Systems, target audience (engineering teams), what differentiates Create from stock FreeCAD 4. **High-level feature summary:** - **ztools** workbench — unified Part Design/Assembly/Sketcher interface, custom datum creation (16 modes), enhanced pocket, assembly patterns, spreadsheet formatting - **Silo** workbench — parts database with revision control, BOM, team collaboration (PostgreSQL + MinIO + Go server) - **Catppuccin Mocha theme** — dark theme applied application-wide - **Origin system** — pluggable file backends (local vs Silo), origin selector widget - **Update checker** — background Gitea releases API monitoring 5. **Version info** — Kindred Create v0.1.0, FreeCAD base v1.0.0, LGPL-2.1-or-later license 6. **Repository URLs:** - Main repo: `https://git.kindred-systems.com/kindred/create` - ztools: `git.kindred-systems.com/forbes/ztools` - silo-mod: `git.kindred-systems.com/kindred/silo-mod` - OndselSolver: `git.kindred-systems.com/kindred/solver` 7. **Link to other docs** — reading order for the rest of the documentation suite ### Key source files to reference - `README.md` (root) — existing project overview - `pixi.toml` — project metadata (name, version, description) - `CMakeLists.txt` — version constants (`KINDRED_CREATE_VERSION`, `FREECAD_VERSION`) - `LICENSE` — LGPL-2.1-or-later - `src/App/Branding.cpp` — branding implementation - `resources/branding/kindred-logo.svg` — logo asset ### Replaces The existing `docs/OVERVIEW.md` is a brief auto-generated index. This issue calls for a proper narrative document. ### Acceptance criteria - [ ] Document is self-contained enough that a new contributor understands what Create is without reading anything else - [ ] All repository URLs are correct and up to date - [ ] Reading order for remaining docs is clear
forbes added the documentation label 2026-02-09 13:45:21 +00:00
forbes commented 2026-02-09 14:13:44 +00:00
Author
Owner
Copy Link

Superseded by the mdBook documentation structure set up in PR #105. The content scope of this issue is now covered by the pages in docs/src/. Remaining content work is tracked in #104.

Superseded by the mdBook documentation structure set up in PR #105. The content scope of this issue is now covered by the pages in `docs/src/`. Remaining content work is tracked in #104.
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
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 documentation
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#87
Delete Branch "%!s()"

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?