docs: change readme structure #369
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
rochecompaan
approved these changes
Sep 9, 2024
See commit 6938661
hillairet
force-pushed
the
hillairet/docs-change-readme-structure
branch
from
cb38474
to
4d1fec0
Compare
rochecompaan
requested changes
Oct 11, 2024
Co-authored-by: Roché Compaan <[email protected]>
|
@rochecompaan Merging to make sure we have this documentation for our newest project. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fix #365
The idea of this new structure is to have the repo's README route the reader to the right section for a given purpose. A reader should only need to go to one file linked from the README at a given time, e.g. when someone wants to set up their local environment, they don't care (yet) about deploying so these two are in two different files.
Also using emojis to make it less dry and easier to scan quickly.
I did only minor doc changes such as section levels and switching references to other files from code format to actual links. The rest of the text is unchanged, just moved.