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

[contributors wanted] Documentation and tutorial overhaul #556

Open
jonas-eschle opened this issue Apr 14, 2024 · 0 comments
Open

[contributors wanted] Documentation and tutorial overhaul #556

jonas-eschle opened this issue Apr 14, 2024 · 0 comments
Labels
discussion For discussions on concepts and ideas good first issue Good for newcomers help wanted Extra attention is needed

Comments

@jonas-eschle
Copy link
Contributor

jonas-eschle commented Apr 14, 2024

The documentation is grown over time, so did the tutorials.

Different tutorials:

Some of these overlap, most have at least parts outdated with old syntax. The goal is to go through them (or parts) to upgrade and re-organize.

The reorganization should include a few new tutorials, either smaller ones on specific topics or larger ones, demonstating a workflow.

Tests generate images automatically, showcasing many parts of zfit (distributions etc) into docs/images/_generated_by_tests. They can be incorporated into the documentation

Please get in contact if you are interested to do parts of it (just comment here) or have tutorials that you want to contribute

@jonas-eschle jonas-eschle added discussion For discussions on concepts and ideas help wanted Extra attention is needed good first issue Good for newcomers labels Apr 14, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
discussion For discussions on concepts and ideas good first issue Good for newcomers help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

1 participant