Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Reorder of the topics? #90

Open
BobSynfig opened this issue Mar 12, 2022 · 0 comments
Open

Reorder of the topics? #90

BobSynfig opened this issue Mar 12, 2022 · 0 comments
Labels
question Further information is requested

Comments

@BobSynfig
Copy link
Collaborator

BobSynfig commented Mar 12, 2022

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
@BobSynfig BobSynfig added the question Further information is requested label Mar 12, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
question Further information is requested
Projects
None yet
Development

No branches or pull requests

1 participant