Reorder of the topics?
BobSynfig opened this issue · comments
BobSynfig commented
Currently the order of the topics doesn't really follow a chronological path.
For example "Setting up your preferred IDE" relies on prerequisites from "Building Synfig using command line"
This could lead to wrong installation (as seen on Windows) and discourage new contributors.
Also, mix of Tutorials, Release Procedures, etc...
The general order should be:
- How to help developers to set up their environment/IDE (Preparation)
- Details of structure of the code, file format and examples/tutorials (Knowledge/Development)
- Packaging/Release (This is to be done by maintainers only, not by contributors)
- Roadmaps/Projects (Future)
Also "List of Hotkeys" should be removed from dev's documentation and present only in user's manual 😛
I propose to reorder the topics as follow:
Current | Proposed |
---|---|
Contributing guidelines Setting up your preferred IDE Code structure Building Synfig using command line Packaging Synfig for distribution Tutorials Release procedure Roadmap Synfig File Format (.sif) Google Summer of Code Projects List of hotkeys Random notes Code of Conduct |
Contributing guidelines Building Synfig using command line Setting up your preferred IDE Code structure Synfig File Format (.sif) Tutorials Packaging Synfig for distribution Release procedure Roadmap Projects Google Summer of Code Random notes Code of Conduct |