New documentation site (Docusaurus) #398
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
The current documentation suffers from a few problems: * It is incomplete * It is not interactive * It is not connected to code and a PR can make it go stale * It is not testable and there's no way to know whether the code snippets still work * API docs can be hard to read * Dead links – no link validation This commit is the first step towards fixing these problems. It: * Adds the missing bits of the documentation and improve the structure * Adds the first interactive examples with more to come * Generates parts of the docs directly from the doc strings * Adds link validation * Improves readability and interconnectedness between the content pages and the API reference With this PR, adding a Blueprint step into the codebase will automatically add it to the docs. If it has a usage example, it will be rendered as a live code snippet. In the future, it will be editable and the CI will verify whether it still works.
adamziel
added
[Type] Documentation
adamziel
changed the title
adamziel
force-pushed
the
docs-docusaurus-site
branch
from
4d083d7 to
ac766ac
Compare
|
I'll go ahead and merge this one. I'm sure there are typos and things missing, but the value add is clear so let's keep iterating from trunk. |
bgrgicak
reviewed
Apr 10, 2024
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.
Solves #323, related to #217.
Description
This commit revisits the documentation site. Here's a preview:
https://wordpress.github.io/wordpress-playground/docs/blueprints-api/steps/
(I went ahead and deployed it to github.io even tough this PR isn't merged yet since it's a much better entry point to the project).
What changed?
This PR:
It is the first step towards addressing the following issues with the current documentation:
Technical details
A few practical example of what's so good about this approach
API Reference integration
Runnable code examples
Reusable content
Inline TOC
Deriving Blueprint steps from code
With this PR, adding a Blueprint step into the codebase will automatically add it to the docs. If it has a usage example, it will be rendered as a live code snippet. In the future, it will be editable and the CI will verify whether it still works.
Docusaurus prevents broken links
TypeScript comment embedded inside of a documentation page