Remove duplicated documents for easier maintenance #447
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
Yuqing-cat
reviewed
Jul 10, 2022
Yuqing-cat
previously approved these changes
Jul 11, 2022
blrchen
previously approved these changes
Jul 11, 2022
Yuqing-cat
approved these changes
Jul 11, 2022
blrchen
approved these changes
Jul 11, 2022
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.
Goal of this PR is to reduce duplicated documents to make it easier for maintenance.
Per GitHub: https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-readmes#about-readmes
if there's no README in root folder, it will automatically find the README file in the docs/ folder. So moving the README.md to docs/ and overriding the README.md in docs/
See results here: https://xiaoyongzhu.github.io/feathr/