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

Rewrite the docs #67

Merged
merged 8 commits into from
Aug 13, 2022
Merged

Rewrite the docs #67

merged 8 commits into from
Aug 13, 2022

Conversation

Peregrine05
Copy link
Member

Rewrote the docs.

  • Reorganized the articles, and updated and corrected the information contained therein.

Rewrote the docs.

- Reorganized the articles, and updated and corrected the information contained therein.
@jackjt8 jackjt8 self-requested a review August 11, 2022 16:20
@jackjt8 jackjt8 added the documentation Improvements or additions to documentation label Aug 11, 2022
@Peregrine05 Peregrine05 linked an issue Aug 11, 2022 that may be closed by this pull request
6 tasks
@jackjt8
Copy link
Member

jackjt8 commented Aug 11, 2022

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.

@Peregrine05
Copy link
Member Author

Peregrine05 commented Aug 11, 2022

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.

@github-actions
Copy link

github-actions bot commented Aug 11, 2022

PR Preview has been destroyed since this PR is closed.

Copy link
Member

@jackjt8 jackjt8 left a 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.
@Peregrine05 Peregrine05 requested a review from jackjt8 August 12, 2022 02:48
Copy link
Member

@jackjt8 jackjt8 left a 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.
@jackjt8 jackjt8 merged commit 71c6a7a into chunky-dev:master Aug 13, 2022
@Peregrine05 Peregrine05 deleted the rewrite-docs branch August 16, 2022 09:16
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

Successfully merging this pull request may close these issues.

Rework Reference - Introduction
3 participants