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

docs: write GLOSSARY.md — terms, repo URLs, and key file paths #101

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

Tier 4 — Reference

File: docs/GLOSSARY.md

What this document should cover

  1. Terms and definitions:

    • Kindred Create — the full application (FreeCAD fork + addons)
    • FreeCAD — upstream open-source parametric CAD platform (v1.0.0 base)
    • Workbench — FreeCAD's plugin/module system for different tool contexts
    • ztools — Kindred's unified Part Design/Assembly/Sketcher workbench
    • Silo — Kindred's parts database system (workbench + server)
    • Origin — pluggable file backend system (local filesystem vs Silo database)
    • FileOrigin — abstract C++ interface for file backends
    • Preference pack — FreeCAD mechanism for bundling theme + settings
    • Catppuccin Mocha — dark color palette used for theming
    • pixi — conda-based dependency manager and task runner
    • Datum — reference geometry (plane, axis, point) used for modeling
    • Manipulator — FreeCAD mechanism for injecting commands into another workbench
    • QSS — Qt Style Sheet (CSS-like styling for Qt widgets)
    • SSE — Server-Sent Events (Silo real-time activity feed)
    • BOM — Bill of Materials
    • FCStd — FreeCAD standard document format (zip containing XML + BREP)
    • MinIO — S3-compatible object storage (used by Silo server)
    • OndselSolver — Lagrangian constraint solver for Assembly workbench
    • rattler-build — cross-platform package build tool (conda ecosystem)

  2. Repository URLs:

    • Main: https://git.kindred-systems.com/kindred/create
    • ztools: https://git.kindred-systems.com/forbes/ztools
    • silo-mod: https://git.kindred-systems.com/kindred/silo-mod
    • OndselSolver: https://git.kindred-systems.com/kindred/solver
    • GSL: https://github.com/microsoft/GSL
    • AddonManager: https://github.com/FreeCAD/AddonManager
    • googletest: https://github.com/google/googletest

  3. Key file paths quick reference:

    • Bootstrap: src/Mod/Create/Init.py, src/Mod/Create/InitGui.py
    • Origin system: src/Gui/FileOrigin.h, src/Gui/OriginManager.h
    • Theme: src/Gui/Stylesheets/KindredCreate.qss
    • Icons: kindred-icons/, src/Gui/Icons/
    • Build: pixi.toml, CMakeLists.txt, CMakePresets.json
    • CI: .gitea/workflows/build.yml, .gitea/workflows/release.yml
    • Packaging: package/
    • Branding: resources/branding/
    • Tests: tests/
    • ztools commands: mods/ztools/ztools/ztools/commands/
    • Silo commands: mods/silo/freecad/silo_commands.py

Acceptance criteria

  • All domain-specific terms are defined
  • All repository URLs are listed and correct
  • Key file paths cover the most commonly referenced locations
  • Glossary is alphabetically sorted within each section
## Tier 4 — Reference **File:** `docs/GLOSSARY.md` ### What this document should cover 1. **Terms and definitions:** - **Kindred Create** — the full application (FreeCAD fork + addons) - **FreeCAD** — upstream open-source parametric CAD platform (v1.0.0 base) - **Workbench** — FreeCAD's plugin/module system for different tool contexts - **ztools** — Kindred's unified Part Design/Assembly/Sketcher workbench - **Silo** — Kindred's parts database system (workbench + server) - **Origin** — pluggable file backend system (local filesystem vs Silo database) - **FileOrigin** — abstract C++ interface for file backends - **Preference pack** — FreeCAD mechanism for bundling theme + settings - **Catppuccin Mocha** — dark color palette used for theming - **pixi** — conda-based dependency manager and task runner - **Datum** — reference geometry (plane, axis, point) used for modeling - **Manipulator** — FreeCAD mechanism for injecting commands into another workbench - **QSS** — Qt Style Sheet (CSS-like styling for Qt widgets) - **SSE** — Server-Sent Events (Silo real-time activity feed) - **BOM** — Bill of Materials - **FCStd** — FreeCAD standard document format (zip containing XML + BREP) - **MinIO** — S3-compatible object storage (used by Silo server) - **OndselSolver** — Lagrangian constraint solver for Assembly workbench - **rattler-build** — cross-platform package build tool (conda ecosystem) 2. **Repository URLs:** - Main: `https://git.kindred-systems.com/kindred/create` - ztools: `https://git.kindred-systems.com/forbes/ztools` - silo-mod: `https://git.kindred-systems.com/kindred/silo-mod` - OndselSolver: `https://git.kindred-systems.com/kindred/solver` - GSL: `https://github.com/microsoft/GSL` - AddonManager: `https://github.com/FreeCAD/AddonManager` - googletest: `https://github.com/google/googletest` 3. **Key file paths quick reference:** - Bootstrap: `src/Mod/Create/Init.py`, `src/Mod/Create/InitGui.py` - Origin system: `src/Gui/FileOrigin.h`, `src/Gui/OriginManager.h` - Theme: `src/Gui/Stylesheets/KindredCreate.qss` - Icons: `kindred-icons/`, `src/Gui/Icons/` - Build: `pixi.toml`, `CMakeLists.txt`, `CMakePresets.json` - CI: `.gitea/workflows/build.yml`, `.gitea/workflows/release.yml` - Packaging: `package/` - Branding: `resources/branding/` - Tests: `tests/` - ztools commands: `mods/ztools/ztools/ztools/commands/` - Silo commands: `mods/silo/freecad/silo_commands.py` ### Acceptance criteria - [ ] All domain-specific terms are defined - [ ] All repository URLs are listed and correct - [ ] Key file paths cover the most commonly referenced locations - [ ] Glossary is alphabetically sorted within each section
forbes added the documentation label 2026-02-09 13:45:27 +00:00
forbes commented 2026-02-09 14:13:55 +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#101
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?