This repository has been archived by the owner on Apr 17, 2023. It is now read-only.
(MAINT) Reorganize documentation prior to 0.1.0 release #115
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 |
This commit reorganizes and cleans up the documentation ahead of release by: 1. Removing the erroneous readme document, previously used as a placeholder 2. Adding the new concepts folder and moving the telemetry and tool anatomy documents into it 3. Moving the explain subsystem document into the usage folder 4. Updating the image link in the quick start to a github uri 5. Intentionally ordering the documents for the website
michaeltlombardi
force-pushed
the
maint/main/reorganize-documentation
branch
from
a9778a9 to
f125cce
Compare
Prior to this commit, the acceptance tests for the explain command relied on the temporary readme file which existed in the docs folder; as that temporary file has been removed, the tests have been updated to use actual documentation instead.
michaeltlombardi
force-pushed
the
maint/main/reorganize-documentation
branch
from
f125cce to
48484cb
Compare
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
This commit reorganizes and cleans up the documentation ahead of release by: