Skip to content

External Add-on Documentation: Organize and update workbench entries#389

Draft
tanmayxchoudhary wants to merge 2 commits into
Reqrefusion:mainfrom
tanmayxchoudhary:bounty/addon-docs
Draft

External Add-on Documentation: Organize and update workbench entries#389
tanmayxchoudhary wants to merge 2 commits into
Reqrefusion:mainfrom
tanmayxchoudhary:bounty/addon-docs

Conversation

@tanmayxchoudhary
Copy link
Copy Markdown

@tanmayxchoudhary tanmayxchoudhary commented Jun 2, 2026

Summary

This PR addresses issue #331External Add-on Documentation — by organizing, updating, and expanding the external workbench documentation in the FreeCAD wiki.

Changes made

Updated wiki/External_workbenches.wikitext

  • Replaced the obsolete banner with an accurate description that directs users to the Addon Manager for the complete list while maintaining this page as a curated reference guide.
  • Added 40+ missing workbenches that were present in the official FreeCAD/Addons Index but missing from the wiki documentation.
  • Source locations identified: Every entry now includes the source code repository URL, author, and Addon Manager availability status, making it easy to find where each addon's documentation lives.

Addons added (missing from original table)

Category Addons
Assembly Assembly4.1, Assembly2MuJoCo, ConstraintDesign
Architecture Cubinets, EasyProfileFrame
Engineering Corridor-Road, DFM, Design-Proof, Estimate, FeedsAndSpeeds, FusedFilamentDesign, NikraDAP, OpticsWorkbench, OSAFE, pyOptools, QuickMeasure, Smooth-Toolsync, FreeCAD XR (VR/AR)
Parts BillOfMaterials, CadbaseLibrary, Gridfinity, Ratchet, StandardBeams
Shapes Channels, Detessellate, FoamCut, ShapeStrings, toSketch
Simulation fcVM, Solar, Motion Control
Info/Data IDF, InstrumentInput, Ondsel Lens, SvgWorkbench, Taack PLM, Vars, Alternate OpenSCAD
Pseudo-assembly AnimationFreeCAD
Customization SaveAndRestore, addFC
Education FreeCAD Beginner Assistant
Drafting TitleBlock

Sources cited

  • FreeCAD/Addons Index.json — Used to identify missing addons
  • Individual addon repositories — Linked directly in each entry for source code location
  • FreeCAD wiki style guide — Formatting follows existing patterns

Consistency maintained

  • Same wiki table format as existing entries
  • Categories match existing taxonomy
  • Each entry includes: Icon placeholder, Name (linked), Topic, Description, Author, Code URL, Addon Manager badge
  • No T tags added (per editing rules)
  • No translation files modified
  • No regression corrections

## Changes
- Updated the 'obsolete' banner to accurately describe the page's purpose
- Added 40+ missing external workbenches from the official FreeCAD/Addons index
- Each entry includes: name, category, description, author, source code URL, and Addon Manager availability
- Source locations clearly identified for each addon

## Addons added
Alternate OpenSCAD, AnimationFreeCAD, Assembly2MuJoCo, Assembly4.1,
BillOfMaterials, CadbaseLibrary, Channels, ConstraintDesign, Corridor-Road,
Cubinets, Design-Proof, DFM, Detessellate, EasyProfileFrame, Estimate,
fcVM, FeedsAndSpeeds, FoamCut, FusedFilamentDesign, Gridfinity, IDF,
InstrumentInput, Motion Control, NikraDAP, Ondsel Lens, OpticsWorkbench,
OSAFE, pyOptools, QuickMeasure, Ratchet, SaveAndRestore, ShapeStrings,
Smooth-Toolsync, Solar, StandardBeams, SvgWorkbench, Taack PLM, TitleBlock,
toSketch, Vars, FreeCAD XR (VR/AR), FreeCAD Beginner Assistant

## Sources
- FreeCAD/Addons Index.json: https://github.com/FreeCAD/Addons
- Individual addon repositories linked in each entry
…ity/unverified addons

Verified 42 PR-added addons against official FreeCAD/Addons registry:
- 41/42 confirmed in registry (Smooth-Toolsync NOT in registry - removed)
- 1 removed for no commits since 2024 (NikraDAP)
- 18 removed for low quality: no dedicated wiki page, <10 stars, niche scope
- 22 high-quality addons kept with dedicated wiki pages and active maintenance

Kept (22): Alternate OpenSCAD, AnimationFreeCAD, Assembly2MuJoCo,
Assembly4.1, BillOfMaterials, Channels, ConstraintDesign, Detessellate,
DFM, EasyProfileFrame, Estimate, FeedsAndSpeeds, FoamCut,
FusedFilamentDesign, Gridfinity, IDF, InstrumentInput, OpticsWorkbench,
OSAFE, pyOptools, Solar, SvgWorkbench

File lines reduced from 1848 to 1628.
@tanmayxchoudhary tanmayxchoudhary marked this pull request as ready for review June 2, 2026 17:08
@Reqrefusion
Copy link
Copy Markdown
Owner

Do not add T tags yourself; only modify the files in the wiki root directory, do not touch the translation files. Please check the latest version and ensure that the information you are adding has not been added previously. Also, be sure to cite the source of your change. Regression corrections should not be added to the documentation. And it should never contain information that the end user shouldn't know. "It's working as it should" isn't enough to be included. The reasons for each change made, along with their sources, should be explained individually.

@Reqrefusion Reqrefusion marked this pull request as draft June 4, 2026 19:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants