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

docs: extend README with architecture, platform support, and usage detail #247

Merged
forbes merged 1 commits from docs/extend-readme into main 2026-02-16 19:17:45 +00:00
Conversation 0 Commits 1 Files Changed 1 +109 -21
forbes commented 2026-02-16 17:08:08 +00:00
Owner
Copy Link

Summary

Extends the README with sections and detail reflecting the current state of the project.

Changes

  • Header: Added version line (Kindred Create 0.1.0 / FreeCAD 1.2.0 base) and documentation link
  • What is Kindred Create: Rewritten to lead with the editing context system and describe ztools as a command provider rather than a standalone workbench
  • New: Platform support: Table covering Linux (active CI), macOS, and Windows (presets defined)
  • New: Architecture: Three subsections — editing context system (built-in context table, Python API), addon integration (bootstrap module, WorkbenchManipulator, overlays), and unified origin system (FileOrigin interface)
  • Usage: ztools: Rewritten to reflect contextual command injection; broken out by tool category
  • Usage: Silo: Added command table with shortcuts; mentioned auth dock and SSE activity panel
  • Project structure: Expanded tree to show EditingContext.h, BreadcrumbToolBar.h, Stylesheets/, PreferencePacks/, 3rdParty subdirs, package subdirs
  • Installing: Added pixi run test mention
## Summary Extends the README with sections and detail reflecting the current state of the project. ## Changes - **Header**: Added version line (Kindred Create 0.1.0 / FreeCAD 1.2.0 base) and documentation link - **What is Kindred Create**: Rewritten to lead with the editing context system and describe ztools as a command provider rather than a standalone workbench - **New: Platform support**: Table covering Linux (active CI), macOS, and Windows (presets defined) - **New: Architecture**: Three subsections — editing context system (built-in context table, Python API), addon integration (bootstrap module, WorkbenchManipulator, overlays), and unified origin system (FileOrigin interface) - **Usage: ztools**: Rewritten to reflect contextual command injection; broken out by tool category - **Usage: Silo**: Added command table with shortcuts; mentioned auth dock and SSE activity panel - **Project structure**: Expanded tree to show EditingContext.h, BreadcrumbToolBar.h, Stylesheets/, PreferencePacks/, 3rdParty subdirs, package subdirs - **Installing**: Added pixi run test mention
forbes added 1 commit 2026-02-16 17:08:09 +00:00
docs: extend README with architecture, platform support, and usage detail
All checks were successful
Build and Test / build (pull_request) Successful in 35m8s
Details
a8df078eb3 
Add editing context system description, built-in context table, and
Python API reference. Add architecture section covering addon
integration and unified origin system. Expand ztools and Silo usage
sections with command breakdowns. Add platform support table. Expand
project structure tree with Kindred-specific files.
forbes merged commit 73f6641199 into main 2026-02-16 19:17:45 +00:00
forbes deleted branch docs/extend-readme 2026-02-16 19:17:46 +00:00
Sign in to join this conversation.
Reviewers
No Reviewers
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
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#247
Delete Branch "docs/extend-readme"

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?