Refactor docs and README for website #388
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
|
The readme is good. But do you think that we should add more details like a reference to the tutorials / bootcamp or the upcoming blog? Make it more user friendly by listing some of the features on the website. Maybe also link the installation page to the website in the readme? I think we can follow what flutter did on their page https://github.com/flutter/flutter. |
quekyj
suggested changes
Jun 20, 2023
There was a problem hiding this comment.
Look good to me. Might need a little change on the https://github.com/intel/rohd-website/blob/main/docs/_data/navigation.yml to let rohd-website pick up the pages route correctly
quekyj
approved these changes
Jul 26, 2023
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 & Motivation
As we move to using the ROHD Website as the main landing area, this PR migrates most of the README into separate documents for the website. Mostly this is deleting stuff from README and including updates from it into the changes from #359.
Related Issue(s)
Fix #374
Testing
CI should catch things, will also test with rohd-website fork
Backwards-compatibility
No
Documentation
Only docs