Improve README.md #15
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
Link to the source code for each page referenced in the 'Available Pages' sections
- Correct 'Profil' to 'Profile' - Put any 'Coming Soon' pages into a 'Coming Soon' sub-header
- Add a blurb on how to update the codebase - Add a blurb on how to contribute to the main repository
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.
Hello again @ATF19,
As per your request, I've written some preliminary blurbs for the
Documentationsection. I figured how to use the codebase was covered by theInstallationsection, but please let me know if you had specific ideas regarding how you wanted to cover how to use the codebase. I've written blurbs about how to update the codebase, including what.jsfiles need to be updated and how to contribute to the main repository.I should also note I'm not super familiar with how building React-Native Android/iOS applications works (ie. whether or not any changes need to be made in the
./android//./ios/directories in order for the web app to update accordingly after updating the.jsfiles.Additionally, I've added links to the respective source codes for the pages referenced in the
Pagessection. I've used relative links, so they'll link to the repository of wherever the README is being read. I've also created a sub-heading ofComing Soon, and corrected what I presume was a minor typo ofProfiltoProfile.I'd like to re-iterate that the changes I've made to the Documentation section are preliminary, pending your feedback, so please let me know if you had other ideas about how you wanted that filled out.
Thanks,
Correy