Add docs versioning #922
Merged
Add docs versioning #922
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
timocov
suggested changes
Dec 1, 2021
…hat time Added a link to github instead
Reasons: 1. It doesn't work correctly on resize (for example it recreates the chart instead of adjusting the size on resize) 2. We need to design this page first to make it user-friendly
timocov
approved these changes
Dec 6, 2021
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.
Type of PR: enhancement
PR checklist:
Overview of change:
This PR adds enables Docusaurus' versioning feature. We will structure our docs according to the first "use case" mentioned here in the Docusaurus docs:
So we have a "next" version that shows the work in progress documentation, and specific versions like 3.7.0 that contain the documentation for the library
A version has been added for 3.7.0.
I've added an index page with a hero section and a randomly generated example chart. We should improve this index page in the future (we could put an interactive playground here for example) but for now we need something to show when the root of the site is requested.
Is there anything you'd like reviewers to focus on?
Linking between versioned docs requires the .md extension to be included, hence the changes in this PR.