Docs with mdbook & Github Pages #501
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
jhollinger
force-pushed
the
jh/2.0-docs
branch
27 times, most recently
from
b92a4af to
a5da02f
Compare
jhollinger
force-pushed
the
jh/2.0-docs
branch
6 times, most recently
from
787fda2 to
6a03eab
Compare
|
This pull request has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions. |
jhollinger
force-pushed
the
jh/2.0-docs
branch
2 times, most recently
from
a0b0f69 to
f515f12
Compare
|
This pull request has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions. |
jhollinger
force-pushed
the
release-2.0
branch
from
39c3a39 to
eee5367
Compare
jhollinger
force-pushed
the
release-2.0
branch
from
eee5367 to
32852d0
Compare
jhollinger
force-pushed
the
release-2.0
branch
from
32852d0 to
fef3af4
Compare
jhollinger
force-pushed
the
jh/2.0-docs
branch
2 times, most recently
from
7ca68b8 to
71daee9
Compare
Signed-off-by: Jordan Hollinger <[email protected]>
Signed-off-by: Jordan Hollinger <[email protected]>
Signed-off-by: Jordan Hollinger <[email protected]>
jhollinger
force-pushed
the
jh/2.0-docs
branch
from
71daee9 to
3f591e5
Compare
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.
The README for V1 is plenty lengthy as-is, and it will only get worse when we add docs for V2 and a guide for migrating. I propose that when we release the V2 API, we move our primary docs to Github Pages using mdbook. It's a Markdown static site generator written in, and maintained by, Rust. They use it for most of their docs and guides, and I've found it very pleasant to use in other projects. It has themes, full site search, and optional keyboard navigation.
I've begun writing V2 docs in this PR (even if we don't use mdbook, we can copy the markdown to something else, so it's hopefully not wasted effort). To test it out, I've enabled GH Pages for the repo and added a GH Action that publishes from this PR's branch. https://procore-oss.github.io/blueprinter/ Thoughts?