-
Notifications
You must be signed in to change notification settings - Fork 721
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
(docs): Reordered and moved usage guide into an mdbook #4300
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
lrstewart
reviewed
Dec 4, 2023
maddeleine
requested review from
camshaft and
lrstewart
and removed request for
goatgoose and
camshaft
December 8, 2023 19:43
lrstewart
approved these changes
Dec 18, 2023
WesleyRosenblum
approved these changes
Dec 18, 2023
maddeleine
force-pushed
the
doc_reorg
branch
from
December 19, 2023 01:07
67e8068
to
e07f750
Compare
I realized that everything that links to the original usage guide in this repo will be broken by this change. Went through and updated all the links I could find that referenced the usage guide. I had to take some artistic liberties with the links as it seems like we do both relative links and absolute links. So thats why I re-requested reviews 😄. |
WesleyRosenblum
approved these changes
Dec 19, 2023
lrstewart
reviewed
Dec 19, 2023
lrstewart
approved these changes
Dec 20, 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.
Resolved issues:
Resolves #4040. Takes what #4277 started and attempts to break it down into a smaller change.
Description of changes:
This change takes our usage guide and splits each section into a separate file. I broke up the file in a way that fits into the rust mdbook format. Therefore, in order to review this change, you will have to check out my branch, install rust mdbook, and then run the mdbook serve command, which allows you to view the book on your localhost. This enables you to see how the guide has been reordered.
Alternatively, I can apply my reorganization to the usage guide as it is now (a large markdown file), if this change is too large. However, we're going to have to separate the sections into md files eventually, so I don't think this is that far off from where we want to end up.
Call-outs:
The changes I made to the content are listed here:
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.