Added visual documentation of the account menu component #6775
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
MarkOSullivan94
changed the title
danjm
approved these changes
Jul 5, 2019
There was a problem hiding this comment.
Thanks @MarkOSullivan94!
This is a great addition. I agree it will be very helpful to developers new to the codebase. More PRs like these are certainly welcome.
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.
Thought it would be a good idea to add documentation about the components of the project so that they're easier to find for newcomers of the project.
I've recently starting diving into the code and I'm currently trying to figure out where to find all the different components which are used to build the different popup pages or the background pages.
Perhaps I'm finding it difficult because I've never worked with a React app before and the only other chrome extension projects I've seen from the Google tutorials didn't have an architecture like this project.
Having something visual like this would help illustrate exactly what the component is for.
I was debating whether or not it would be a good idea including the relative path to the component within the document however I realise that this could become problematic if there was a refactor and locations changed or directories were renamed.