-
Notifications
You must be signed in to change notification settings - Fork 8
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
Rewrite the docs #67
Rewrite the docs #67
Conversation
Rewrote the docs. - Reorganized the articles, and updated and corrected the information contained therein.
My review will take a while given the scope of the changes however I have been updated over the course of these changes being made so it might not take forever. It may be worth requesting a review from some of the other maintainers due to the scope of the changes. |
I have requested reviews from leMaik and Redox, since they have also worked on the docs, and have a good understanding of how Chunky, especially the more technical aspects of it, functions. |
PR Preview has been destroyed since this PR is closed. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Largely minor/small things that I noticed that need to be addressed.
I did notice a few things that we would, eventually, need to do but they would not block this PR. These points have been noted as such and we would just need a new issue opened so we can work on them if we chose to do them later.
- Made the figures look nicer. - Made some minor changes to the docs.
Fixed some minor readability issues.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
If one more person Approves these changes I will merge them.
Just because of the PR size mainly...
Updated the links to external resources to open in new browser tabs.
Rewrote the docs.