Add SHARK user guide to root of docs directory #528
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
This PR adds a SHARK user guide to root of docs directory and does some basic information re-architecture to point installation paths of current main readmes to the new user guide.
Second commit. Focused on cleaning up feedback from Scott's review as well as additional fixes to a couple broken links.
|
This PR is a new one based on feedback from previous PR. Since I changed the origin branch I had to create a new PR chain. Kept original commit and added changes to second commit. |
ScottTodd
approved these changes
Nov 14, 2024
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.
Progress on #458
This PR adds a SHARK user guide to root of docs directory and does some basic information re-architecture to point installation paths of current main readmes to the new user guide.
One new landing page and removal of duplicate installation paths in SD folder to point to both nightly / new release page depending on use case.
Incorporated a mini guide on supported options for the SD Server / Client in the user guide.
Changed root readme to include a path for users so that anyone who lands on the main SHARK readme can quickly get started as a non-developer.