Mode and configuration documentation cleanup #989
Merged
Conversation
This file contains hidden or 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
asbjornu
force-pushed
the
feature/mode-documentation-cleanup
branch
2 times, most recently
from
c07178e to
7fe140d
Compare
|
@asbjornu @JakeGinnivan is there a way to run readthedocs locally to test how it works before pushing? |
|
Yeah, install mkdocs locally, then run |
asbjornu
force-pushed
the
feature/mode-documentation-cleanup
branch
from
7fe140d to
16997a6
Compare
|
@JakeGinnivan Thanks for the tip. I clicked through the documentation locally and found a bug plus a better way to organize the versioning modes. I've also rebased the PR. |
|
@JakeGinnivan thanks! I have it up and running locally now as well (after a little fighting with python and pip) |
Changed the configuration options list items into headers, so each section is easier to read and write and can fit examples, sub-sections and such.
asbjornu
force-pushed
the
feature/mode-documentation-cleanup
branch
from
ebf1fa6 to
9cf8c30
Compare
|
@JakeGinnivan I added a test in 9cf8c30 to ensure that all documentation files exist in the index. Through that, I found one that wasn't ( |
|
@asbjornu that is awesome! |
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.
This PR should fix a dead link from
configuration.mdtoversioning-mode.md, moves the latter file into thereferencefolder, consolidates its content with the different mode files and cleans up all related files in many various ways that I hope should improve this part of the documentation. I have no idea how this looks and works on ReadTheDocs, but fingers crossed this doesn't break anything!