Add improved documentation for installation and getting started #5545
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
domdomegg
requested changes
Feb 12, 2024
There was a problem hiding this comment.
Hi @lucyjin3, thanks for the contribution! There is already user documentation linked to from the README. I'm concerned that this PR might be duplicating some of that, as well as the in-app messaging users will already see. This therefore potentially increases the scope of what needs to be maintained for limited user benefit.
Could you clarify what you expect adding this documentation here will do over and above the existing documentation?
domdomegg
reviewed
Feb 12, 2024
| @@ -1 +0,0 @@ | |||
| Include release notes with alpha releases | |||
There was a problem hiding this comment.
I'm not sure what removing this file is doing, or whether it's related to this PR?
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.
Description (required)
Updated the README file to improve clarity and provide better guidance for users installing, getting started with, and using the Commons Android app. Added sections for installation instructions, getting started tips, and usage examples to enhance the user experience and facilitate contributions to the project.
Installation Instructions:
Check if the installation instructions are clear and comprehensive, covering the steps required to install and set up the app on an Android device or emulator.
Verify if there are any dependencies or prerequisites mentioned, such as minimum Android version or additional libraries.
Getting Started Section:
Assess whether there's a clear "Getting Started" section that helps new users understand how to use the app after installation.
Look for information on basic app functionality, navigation, and any initial setup steps required.
Usage Examples:
Look for usage examples or tutorials that demonstrate how to use key features of the Commons Android app.
Evaluate if there are any sample workflows or scenarios provided to help users understand the app's capabilities.
Tests performed (required)
Tested ProdDebug build variant on Pixel 5 device with API level 30.