Skip to content

Rewrite the documentation #3

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

Open
ChRen95 opened this issue Sep 22, 2023 · 0 comments
Open

Rewrite the documentation #3

ChRen95 opened this issue Sep 22, 2023 · 0 comments

Comments

@ChRen95
Copy link
Member

ChRen95 commented Sep 22, 2023

The documentation should be rewritten.
As of right now the documentation is very much focused on programmers or better people with a programming background.
My opinion, the documentation should feature several open access papers witch are recalculated.
For example several examples published by C. Overhagen in his PhD or some from "Der Kalibreur".
Also a dedicated section for the IMF's own continuous rolling mill, this would help partners from IMF as well as students especially.

Furhermore I would suggest sections like:

Introduction to PyRolL (For Programmers)
Introduction to PyRolL (For Technologists)

@axtimhaus axtimhaus transferred this issue from pyroll-project/pyroll-core Oct 10, 2023
@axtimhaus axtimhaus changed the title Update the documentation Rewrite the documentation Oct 12, 2023
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

No branches or pull requests

1 participant