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

Overhaul the entire documentation #129

Open
uap-universe opened this issue Apr 27, 2023 · 1 comment
Open

Overhaul the entire documentation #129

uap-universe opened this issue Apr 27, 2023 · 1 comment
Labels
documentation Improvements or additions to documentation

Comments

@uap-universe
Copy link
Collaborator

There are some problems with the documentation:

  • some parts still seem to contain pre-fork information, like e.g. the module name in the quick start guide
  • the structure of the documentation is not very intuitive and the structure in the code is even worse
  • the example code is inconsistent - e.g. sometimes it uses strong typing for the settings, sometimes it doesn't, etc.
@uap-universe uap-universe added the documentation Improvements or additions to documentation label Apr 27, 2023
@pj-alvarado10
Copy link

I could help, but I am not a great connoisseur of the subject and of how the library works to be able to polish the documentation much more, especially now with version 3.0.0 which has much cleaner code thanks to all your efforts. Anything I could help improve the documentation, you can tell me.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants