docs: update README structure #2115
Merged
Conversation
This file contains hidden or 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
maschad
commented
Oct 3, 2023
maschad
force-pushed
the
docs/update-contributing-guide
branch
from
701bc70 to
05015a1
Compare
maschad
changed the title
achingbrain
requested changes
Oct 4, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
Title
docs: update README structure and contributing guidelines
Description
I have updated the structure of the
READMEto be a bit more welcoming by moving monorepo file structure below the ## Project Status. The assumption is that a first time consumer is less interested in the monorepo as opposed to just installing and using the library.Notes & open questions
Change checklist