Add Project Anatomy Section to README.md #82
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
Add new project anatomy section to the readme to let new developers get up to speed on how the project is organized.
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.
Add new project anatomy section to the readme to let new developers get up to speed on how the project is organized.
Readme Updates for New Developers
Description
The readme update focused on improving the beginner developer experience as they read the documentation for the project. Mentions of Docker and Node from the documentation website have been moved to the readme to clear any confusion on developer and production differences. In addition, commands are provided to check if the applications are installed. An entire section titled Project Anatomy is created to allow developers to understand purpose of major directories in the front and backend.
Type of change
Checklist: