-
-
Notifications
You must be signed in to change notification settings - Fork 5
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Update documentation #760
Merged
Merged
Update documentation #760
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
Codecov Report
@@ Coverage Diff @@
## develop #760 +/- ##
========================================
Coverage 57.61% 57.61%
========================================
Files 143 143
Lines 9223 9223
========================================
Hits 5314 5314
Misses 3909 3909 |
Fix linting and indentation issues
andrewtpham
approved these changes
Sep 6, 2021
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good, thanks for all this clean up work 💪 @TAnas0
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.
What is the Purpose?
Update our basic documentation in the repository.
The README is a bit overwhelming and too specific. It also tries to describe all possible scenarios for running Activity:
I'd rather have a friendlier README with a quick
Getting Started
section based on Docker and Docker Compose, and leave the rest to the user who is doing the setup, and knows their machine.What was the approach?
Briefly describe the approach used to address the issue
Are there any concerns to addressed further before or after merging this PR?
None
Mentions?
@andrew @ninetteadhikari
Issue(s) affected?
Fix #758