Commit Graph

26 Commits

Author SHA1 Message Date
forbes
7f02fd182e docs: comprehensive documentation refresh — remove stale references, add missing content
All checks were successful
Build and Test / build (pull_request) Successful in 24m46s
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
forbes
87a0af0b0f phase 1: copy Kindred-only files onto upstream/main (FreeCAD 1.2.0-dev)
Wholesale copy of all Kindred Create additions that don't conflict with
upstream FreeCAD code:

- kindred-icons/ (1444 Catppuccin Mocha SVG icon overrides)
- src/Mod/Create/ (Kindred Create workbench)
- src/Gui/ Kindred source files (FileOrigin, OriginManager,
  OriginSelectorWidget, CommandOrigin, BreadcrumbToolBar, EditingContext)
- src/Gui/Icons/ (Kindred branding and silo icons)
- src/Gui/PreferencePacks/KindredCreate/
- src/Gui/Stylesheets/ (KindredCreate.qss, images_dark-light/)
- package/ (rattler-build recipe)
- docs/ (architecture, guides, specifications)
- .gitea/ (CI workflows, issue templates)
- mods/silo, mods/ztools submodules
- .gitmodules (Kindred submodule URLs)
- resources/ (kindred-create.desktop, kindred-create.xml)
- banner-logo-light.png, CONTRIBUTING.md
2026-02-13 14:03:58 -06:00
Chris Hennes
c8eefab345 Project: Revise PR message guidelines for clarity 2025-11-02 12:53:43 -06:00
Chris Hennes
7d6c9c0ee6 Contributing: Clarify use of Draft and On hold 2025-08-04 19:39:07 +02:00
Kacper Donat
536775188b Contributing: Add requirement to clearly mark ownership for cherry-picked PRs (#22001)
* Contributing: Add requirement to clearly mark ownership for cherry-picked PRs

---------

Co-authored-by: Chris Hennes <chennes@pioneerlibrarysystem.org>
Co-authored-by: Furgo <148809153+furgo16@users.noreply.github.com>
2025-06-29 19:11:30 +00:00
Kacper Donat
bf42236763 Contributing: Add information about breaking changes
This adds list item for the contribution requirements to ensure that each breaking change is handled properly and documented.
2025-01-19 10:34:28 -05:00
luzpaz
7782fd6827 Trim lines ending with superfluous whitespace 2024-12-22 08:50:37 -05:00
Max Wilfinger
d9b9b58681 Add details for UI changes 2024-05-27 10:38:30 -05:00
Tuomas Kuosmanen
9688337554 Update CONTRIBUTING.md to reflect branch naming change
FreeCAD switched to use "main" branch in development. Updating CONTRIBUTING.md to reflect that.

https://github.com/FreeCAD/FreeCAD/discussions/10226
2023-10-18 14:22:45 -05:00
sliptonic
8dc6c67fc0 Update CONTRIBUTING.md
Co-authored-by: Chris Hennes <chennes@pioneerlibrarysystem.org>
2023-08-23 14:49:34 -05:00
sliptonic
d38d949cf0 Clarify adding administrators 2023-08-22 17:32:27 -05:00
sliptonic
2644a01fe9 Update CONTRIBUTING.md 2023-08-22 17:27:21 -05:00
Rebecca Dodd
97271f90d0 Fix typo in Roles 2023-05-15 17:46:41 +01:00
Daniel-Khodabakhsh
c815cb8a82 Update CONTRIBUTING.md
Co-authored-by: Chris Hennes <chennes@pioneerlibrarysystem.org>
2023-02-27 10:33:24 -06:00
Daniel-Khodabakhsh
d4b61af3d3 Improve usage of the term 'platform' in CONTRIBUTING.md
This PR improves `CONTRIBUTING.md` by replacing some instances of the term `Platform` with `GitHub` for the following reasons:

* This was unnecessary legalese which made the document harder to comprehend.
* Fixes a few ambiguous usages of the term:
  * In one usage there is ambiguity if there is a platform called "Platform".
  * Ambiguous with other usages of the word when referring to the runtime platform.
* Fixes one incorrect usage of the term, where reference to `"Platform"` was intended to refer to any other platform OTHER THAN `GitHub` or `"the Platform"`.
2023-02-27 10:33:24 -06:00
Yorik van Havre
780d8416e2 Adding info to hand over the copyright to the FPA 2023-01-01 11:01:06 -05:00
sliptonic
c490b93173 Update CONTRIBUTING.md
Updating 8.1 policy for inviting maintainers
2022-11-02 17:08:10 -04:00
sliptonic
5c946c0e8f Update CONTRIBUTING.md
split 5.1
2022-11-02 17:08:10 -04:00
sliptonic
7019e3d218 Update CONTRIBUTING.md
Typo 1.1
Remove explicit time frame in 6.11.1
change capitalization in 6.11.2  "Primary Developer" is intentionally not defined.
Remove unnecessary "User" 6.11.17
2022-11-02 17:08:10 -04:00
sliptonic
68f9f62af2 Update CONTRIBUTING.md
Clarify 5.6
Change 2.4 to redirect users to forum for help/general discussion
Change 1.2 to strike 'useful'
2022-11-02 17:08:10 -04:00
sliptonic
a4443de5fa Update CONTRIBUTING.md
Revise the policy for contributors to be included in the "About" dialog
2022-11-02 17:08:10 -04:00
sliptonic
0f3d3a2821 Update CONTRIBUTING.md
Change 'patch' to 'contribution'
2022-11-02 17:08:10 -04:00
sliptonic
a6d67a701f Update CONTRIBUTING.md
typos
2022-11-02 17:08:10 -04:00
sliptonic
1fc85e07c2 Update CONTRIBUTING.md
remove redefinition of 'user'
2022-11-02 17:08:10 -04:00
sliptonic
2cacd85047 More markdown formatting 2022-11-02 17:08:10 -04:00
sliptonic
3022eb3a37 Moving to markdown format 2022-11-02 17:08:10 -04:00