Move guides to new docs_site #4
Closed
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
jgayfer
force-pushed
the
docs_site
branch
2 times, most recently
from
73a198c to
30fb811
Compare
jgayfer
force-pushed
the
move_docs
branch
2 times, most recently
from
b842470 to
81d257d
Compare
added 5 commits
May 18, 2018 15:16
The docs index wasn't meant to be a long term solution; it was a means to aid in navigating the docs while on GitHub. Since the docs will now live in their own site, there won't be a need to navigate the docs on GitHub.
This is a requirement of Middleman, the platform the docs site is built on. Otherwise, we can't generate HTML from the markdown.
This change allows for relative links to work in the context of the docs site.
This change keeps the original top level file/directory names as we had previously.
|
Test PR no longer needed. |
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 depends on solidusio#2739
This PR moves all of the existing documentation to the new docs site.
There are a few changes that had to be made to the docs in order to have them play nice with Middleman.
.mdto.html.md.mdto.htmlOther than what is mentioned above, there are no changes made to the docs themselves. The goal was to keep the docs as pure markdown to ensure they remain platform agnostic should they be used in a different capacity in the future.