FreeCAD / FreeCAD/DevelopersHandbook
[Feature Request /Proposal] Moving the Handbook to a new framework.
- Dominant language
- HTML
- Stars
- 81
- Forks
- 56
- PR merge metrics
- No merged PRs in 30d
Description
This issue is on the back of a discussion that has been had on the discord, and is to ensure proper etiquette before attempting a PR with such a radical change.
The proposal is to move the Developers Handbook to a new framework (most likely Material for MkDocs, the framework used for the [blender documentation](https://docs.blender.org/).
The goal of the initiative would be to have a framework that still is easy to contribute to, whilst also having the QoL features that would improve the on-boarding of developers whom are thinking of becoming contributors.
Contributor guide
No contributing guide indexed for this repository
Research direction
Start by reviewing the Discord discussion referenced in the issue and the current Developers Handbook structure. Compare the existing handbook with Material for MkDocs and the Blender documentation example, then establish the agreed framework and migration scope; completion would require consensus before a migration PR is attempted.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- html
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Quiet
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100