Update the documentation framework for v7 #1915
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
ethomson
force-pushed
the
docs-7
branch
3 times, most recently
from
4f6fb7a to
b67ff02
Compare
darcyclarke
added
the
release: next
ethomson
force-pushed
the
docs-7
branch
5 times, most recently
from
304c041 to
3358a18
Compare
darcyclarke
removed
the
release: next
Update the `docs-build.js` script to parse the name, man page section, and description out of the frontmatter and use that for the generated man page. This helps avoid repetition between the frontmatter section and the body of the page itself. Update the docs pages themselves to remove the H1 (title) and H2 (description). Finally, ensure that the frontmatter begins in column 0 on each page.
Many markdown parsers choke on code blocks spread over multiple lines.
Avoid needless and unnecessary redundancy.
These links now reflect the reality of the filesystem and their paths.
Again, this reflects the path hierarchy and structure, and matches the old documentation URLs.
Update links to reflect where the pages actually are.
Drop Gatsby, use a simplified custom static site generator that uses GFM and a template for extremely lightweight docs.
darcyclarke
added
the
release: next
2 tasks
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.
Note: this is the docs framework targeted against the v7 release.
Some updates to the documentation framework (the scripts that build and display docs) to both make them a little shinier and easier to work with, and to help align these docs with the npm registry documentation. (The npm registry documentation includes these docs as a subset, so there are some changes to make them more easily consumable.)
Drop Gatsby. For our needs, it's big and slow, and it produces complex content. Introduce a new application "dockhand" that takes our markdown content, converts that to HTML, puts that in a simple template, and does some minor translations. The output is standalone HTML files with zero external dependencies.
An update to the
docs-build.jsmanpage generation script to parse data out of the frontmatter of the documentation pages, instead of parsing the documentation content. Moving this to metadata makes the content focused on the display, and the frontmatter is focused on the metadata.Update the documentation itself to move the metadata into frontmatter.
Move the commands directory to
commands(instead ofcli-commands). Since they're in theclirepo, it's clear that they're cli commands. 😀Fix a few broken links, and a few typos.
Aside from (5), there are no changes to the documentation content itself.