Versioned documentation
See original GitHub issueAs an organization, we would like to provide versioned documentation, so that users on can always access the most up-to-date documentation for their version.
This would be similar to the React website, where the documentation displayed by default is for the most recent version, while they provide a React Versions page that allows the user to switch to documentation for older versions.
In order to make this happen, we need to think through a few things:
-
We’re using
gatsby
withgatsby-plugin-mdx
for our documentation. What’s the best approach to maintaining multiple versions of the same documentation files? -
Our documentation uses Chakra components for component examples, live code editor output, and styling the mdx content of each page. The examples and editor output should use components from the version of Chakra specific to the pages the user is currently viewing, while the mdx components of each page should remain the same for all versions so that we can maintain styling/layout of our docs pages independently using the most up-to-date Chakra version. How can we use multiple versions of Chakra UI simultaneously in order to accomplish this?
These feel like potentially non-trivial problems, so we could really use outside expertise and community feedback to help guide us in a good direction. Any help is greatly appreciated!
Issue Analytics
- State:
- Created 3 years ago
- Reactions:2
- Comments:7 (5 by maintainers)
Top GitHub Comments
I don’t think we’ll need to update v0 docs once we release v1. All efforts will move to v1 docs instead.
Let’s leave out the need to create something fancier.
@with-heart, I think vercel can make this a lot easier for us.
We can simply alias the current build to
v0.chakra-ui.com
and we should be good with this.What do you think?