question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Versioned documentation

See original GitHub issue

As 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:

  1. We’re using gatsby with gatsby-plugin-mdx for our documentation. What’s the best approach to maintaining multiple versions of the same documentation files?

  2. 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:closed
  • Created 3 years ago
  • Reactions:2
  • Comments:7 (5 by maintainers)

github_iconTop GitHub Comments

1reaction
segunadebayocommented, Jul 10, 2020

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.

1reaction
segunadebayocommented, Jun 30, 2020

@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?

Read more comments on GitHub >

github_iconTop Results From Across the Web

Versioned Documentation - Read the Docs
Read the Docs supports multiple versions of your repository. On initial import, we will create a latest version. This will point at the...
Read more >
Versioning - Docusaurus
You can use the versioning CLI to create a new documentation version based on the latest content in the docs directory. That specific...
Read more >
Best Practice: Managing versioned documentation in ... - K15t
Best Practice: Managing versioned documentation in Confluence ... We employ Scroll Versions to manage the documentation of our Scroll add-ons in Confluence.
Read more >
Versioned Documentation - Trevor Blades
In this post, I'll explain the docs versioning strategy that we use at Apollo. It's important to note that we use Gatsby to...
Read more >
Versioned documentation - Help - Jekyll Talk
I'm using GitHub Pages (Jekyll) to create PREFS python library documentation. And i chose the just-the-docs theme because it easily creates ...
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found