d3: regen 8.6 API docs #4805
Merged
d3: regen 8.6 API docs #4805
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
…6 of operate API generation
|
👋 🤖 🤔 Hello, @pepopowitz! Did you make your changes in all the right places? These files were changed only in docs/. You might want to duplicate these changes in versioned_docs/version-8.6/.
You may have done this intentionally, but we wanted to point it out in case you didn't. You can read more about the versioning within our docs in our documentation guidelines. |
|
Merging this into the docusaurus 3 branch. All 8.6 api docs have been re-generated, and there is now infrastructure to generate any back-version of API docs! Next I'll be doing exactly that, working my way backwards through the releases/APIs. |
pepopowitz
merged commit 8d17237
into
pepopowitz/3736-docusaurus-lets-gooooo
7 of 8 checks passed
pepopowitz
deleted the
pepopowitz/3736-docusaurus/regen-vcurrent-apis
branch
pepopowitz
commented
Dec 20, 2024
There was a problem hiding this comment.
All generation strategies are re-written to take configuration passed in, so that we can use the docusaurus configuration directly instead of duplicating in these files.
There was a problem hiding this comment.
Specs were pulled in from the last version prior to the 8.6 launch, and placed in a version-8.6 folder. As I work backwards through these versions, I'll be able to add each APIs spec for each version side by side.
There was a problem hiding this comment.
This file has the bulk of the changes for the generation process, to accommodate back-versions.
Luckily the plugin we're using already has support for back-versions; we just need to modify how we're calling it, based on the commands entered into the console.
|
|
||
| // Load the API configs from the docusaurus.config.js file. | ||
| function loadAPIConfigs() { | ||
| const config = require("../docusaurus.config"); |
There was a problem hiding this comment.
Everything we were using in the individual generation strategies is already in the docusaurus config!
There was a problem hiding this comment.
These versions.json files are artifacts of the generator plugin. I don't believe they get used at all, but I left them because they seem harmless, and I wanted to modify the output of the generator as little as possible.
There was a problem hiding this comment.
Another unused artifact of the generators. Sidebars in numbered versions only support one large JSON file for the entire tree; this typescript file would never be used by docusaurus.
It could however be used by whomever re-generates, to either spot-check that the sidebars didn't change, or if they did change for some reason, these could mostly be copy/pasted into the top-level sidebars file to accommodate the changes.
There was a problem hiding this comment.
Hooray for valid markdown!!!! All these docs are now properly formed for the new MDX parser in docusaurus 3.
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.
Description
Part of #4799.
When should this change go live?
holdlabel or convert to draft PR)PR Checklist
/versioned_docsdirectory./docsdirectory (aka/next/).