Update README.md #806
Merged
Update README.md #806
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
|
Does this mean that we expect the user to go to the myria website instead of reading the local README.md? I think at some point our consensus was having an unique readme file for each repo that can be accessed either by checking out a repo or being pulled to the website. |
|
The readme for the repository shouldn't have anything to do with the docs that are shown on the website. The consensus was to pull the docs from each repo so that we can maintain them in the context of the code. The docs are not the readme, though. |
|
@jingjingwang could you comment on status of this PR? Didn't we decide on a different approach (pulling the README docs for each repo directly into the website repo)? |
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.
Instead of using a symlink to a markdown file in the docs, use a separate readme.