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.

Support multiple versions in the website documentation

See original GitHub issue

The documentation is currently updated prior to a minor release with the supported functionality, thus losing the information of what is supported on each version. The immediate impact is that documentation cannot be written unless the functionality is completed because it needs to be deployed only after the release.

The support of multiple versions within the documentation would allow a smoother evolution of the documentation during development where a “in development” meta version can be updated for each individual functionality added to the system.

General requirements:

  • the documentation must remain at without affecting the product website
  • it must support markdown with html customisations
  • it must be searchable
  • it must allow checking references
  • it must support multiple versions (with navigation between version)
  • it must be controlled through CI (deployment from the master branch)
  • optionally: it must notify users that are browsing an older version of the documentation to navigate to the latest released version

Issue Analytics

  • State:closed
  • Created 2 years ago
  • Comments:6 (6 by maintainers)

github_iconTop GitHub Comments

imsducommented, Jun 15, 2021

What an older version can look like:

Screenshot 2021-06-15 at 16-23-14 Blue Brain Nexus

imsducommented, Jun 22, 2021

Completed when merging #2555

Read more comments on GitHub >

github_iconTop Results From Across the Web

Support multiple versions of docs. · Issue #193 - GitHub
I'd like to be able to host different docs for different versions of my code. I know there are services like ReadTheDocs that...
Read more >
Document how to support multi versions for docs using ...
The easiest way is to deploy the site and its versions on your own server using a runner with the shell executor, and...
Read more >
Multi-version Documentation - Medium
A multi-version manual is created for different versions of your software. The main specific of a multi-version manual is that you don't ...
Read more >
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 >
Publishing Multiple Versions of Content - Paligo
If you have documentation for multiple versions of a product, you may want users to be able to select which version they see....
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 Post

No results found

github_iconTop Related Hashnode Post

No results found