Improve how documentation pages are rendered #1776
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
nickcharlton
force-pushed
the
nc-readme-as-docs-file
branch
from
63b8e22 to
4bd8f45
Compare
pablobm
reviewed
Sep 24, 2020
nickcharlton
added
the
documentation
nickcharlton
force-pushed
the
nc-readme-as-docs-file
branch
from
33f7db9 to
a4846fa
Compare
nickcharlton
changed the title
nickcharlton
force-pushed
the
nc-readme-as-docs-file
branch
from
a4846fa to
7c60246
Compare
|
I ended up completely visiting this one, as I wasn't happy with the direction the I also backfilled some feature specs here: I did this to drive me getting this working but maybe they could be better or just go. |
nickcharlton
force-pushed
the
nc-readme-as-docs-file
branch
3 times, most recently
from
7b0f5f8 to
563995c
Compare
* Extracts an object to encapsulate rendering a given page (which also allows us to explicitly test it), * Allows us to render pages without the YAML frontmatter, which was making a mess of the README and Contributing Guide.
nickcharlton
force-pushed
the
nc-readme-as-docs-file
branch
from
563995c to
bc33fb5
Compare
|
It turns out that the mysterious CI failure was related to case sensitive file systems: CI, being Linux, is case sensitive and so Finally, paired with @iftheshoefritz to go over this, so I'm going to merge this now! |
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.
Taking @EWright212's work from #1705, as I don't seem to be able to push to that branch.
allows us to explicitly test it),
making a mess of the README and Contributing Guide,