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

docs: write UPSTREAM_MODULES.md — map of src/Mod/* with Kindred patch status #99

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

Tier 4 — Reference

File: docs/UPSTREAM_MODULES.md

What this document should cover

  1. Purpose — brief map of all ~37 modules in src/Mod/, indicating which are stock FreeCAD and which have Kindred modifications

  2. Module inventory table:

    Module Status Notes
    Assembly/ Kindred patches findPlacement() datum/origin handling
    PartDesign/ Stock + ztools injection ztools injects via manipulator
    Sketcher/ Stock No known Kindred patches
    Create/ Kindred-only Bootstrap module (see CREATE_MODULE.md)
    AddonManager/ Submodule github.com/FreeCAD/AddonManager
    Part/ Stock Parametric modeling
    TechDraw/ Stock 2D drawing generation
    Spreadsheet/ Stock ztools adds formatting on top
    Start/ Stock Start page workbench
    Draft/ Stock 2D drafting
    BIM/ Stock Building information modeling
    CAM/ Stock Computer-aided manufacturing
    Fem/ Stock Finite element analysis
    Mesh/ Stock Mesh operations
    ... ... ...

  3. Modules with known Kindred patches:

    • Assembly/ — findPlacement() extended for datum and origin handling (PR #83)
    • Create/ — entirely Kindred-authored (see CREATE_MODULE.md)
    • Any others discovered during documentation

  4. How to check if a module has Kindred patches:

    • Compare against upstream FreeCAD 1.0
    • Look for Kindred-specific comments or branding
    • Check git blame for Kindred authors

  5. Cross-references — link each major module to its FreeCAD wiki documentation where relevant

Key source files

  • src/Mod/ — all 37 module directories
  • src/Mod/Assembly/ — known Kindred patches
  • src/Mod/Create/ — Kindred bootstrap module

Acceptance criteria

  • All ~37 modules are listed with stock/modified/Kindred-only status
  • Known Kindred patches are documented with PR references
  • A developer can quickly identify which modules are safe to update from upstream
## Tier 4 — Reference **File:** `docs/UPSTREAM_MODULES.md` ### What this document should cover 1. **Purpose** — brief map of all ~37 modules in `src/Mod/`, indicating which are stock FreeCAD and which have Kindred modifications 2. **Module inventory table:** | Module | Status | Notes | |--------|--------|-------| | `Assembly/` | Kindred patches | findPlacement() datum/origin handling | | `PartDesign/` | Stock + ztools injection | ztools injects via manipulator | | `Sketcher/` | Stock | No known Kindred patches | | `Create/` | Kindred-only | Bootstrap module (see CREATE_MODULE.md) | | `AddonManager/` | Submodule | `github.com/FreeCAD/AddonManager` | | `Part/` | Stock | Parametric modeling | | `TechDraw/` | Stock | 2D drawing generation | | `Spreadsheet/` | Stock | ztools adds formatting on top | | `Start/` | Stock | Start page workbench | | `Draft/` | Stock | 2D drafting | | `BIM/` | Stock | Building information modeling | | `CAM/` | Stock | Computer-aided manufacturing | | `Fem/` | Stock | Finite element analysis | | `Mesh/` | Stock | Mesh operations | | ... | ... | ... | 3. **Modules with known Kindred patches:** - `Assembly/` — `findPlacement()` extended for datum and origin handling (PR #83) - `Create/` — entirely Kindred-authored (see CREATE_MODULE.md) - Any others discovered during documentation 4. **How to check if a module has Kindred patches:** - Compare against upstream FreeCAD 1.0 - Look for Kindred-specific comments or branding - Check git blame for Kindred authors 5. **Cross-references** — link each major module to its FreeCAD wiki documentation where relevant ### Key source files - `src/Mod/` — all 37 module directories - `src/Mod/Assembly/` — known Kindred patches - `src/Mod/Create/` — Kindred bootstrap module ### Acceptance criteria - [ ] All ~37 modules are listed with stock/modified/Kindred-only status - [ ] Known Kindred patches are documented with PR references - [ ] A developer can quickly identify which modules are safe to update from upstream
forbes added the documentation label 2026-02-09 13:45:26 +00:00
forbes commented 2026-02-09 14:13:53 +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#99
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?