Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Feature: Add Versioning to the Documentation #211

Open
Musilah opened this issue Dec 16, 2024 · 0 comments
Open

Feature: Add Versioning to the Documentation #211

Musilah opened this issue Dec 16, 2024 · 0 comments
Assignees
Labels
enhancement New feature or request

Comments

@Musilah
Copy link
Contributor

Musilah commented Dec 16, 2024

Is your feature request related to a problem? Please describe.

There isn't a problem related to the feature request but it would be a good addition to keep track of the changes to the docs.

Describe the feature you are requesting, as well as the possible use case(s) for it.

Implement versioning for the documentation site following the Docusaurus Versioning Convention.

The versions should follow major changes in the docs such as renaming, adding and deleting services. It should also allow users to access previous versions of the documentation for reference.

Indicate the importance of this feature to you.

Should-have

While not critical, this feature would significantly enhance the maintainability and usability of the documentation.

Anything else?

Read up on the versioning documentation before attempting to update since this will be a major change. Adding versioning to the docs will increase the build time.

Ensure the suitability of versioning by evaluating the following recommendation from Docusaurus:

"Versioning is best suited for websites with high traffic and rapid changes to documentation between versions. If your documentation rarely changes, don't add versioning to your documentation."

@Musilah Musilah added the enhancement New feature or request label Dec 16, 2024
@Musilah Musilah self-assigned this Dec 18, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant