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

Enhance documentation site to have versions #13908

Open
timsaucer opened this issue Dec 26, 2024 · 0 comments
Open

Enhance documentation site to have versions #13908

timsaucer opened this issue Dec 26, 2024 · 0 comments
Labels
enhancement New feature or request

Comments

@timsaucer
Copy link
Contributor

Is your feature request related to a problem or challenge?

In other projects, when you go to the API documentation, you can select a specific version. As our user base is growing and there are breaking changes between versions, it would be nice to have an option for users to select a documentation version. For example, as we are about to merge in DF44 if someone reviews the online documentation for Execution Plan but they are working with DF 43 it will cause confusion since the plan properties have changed.

Describe the solution you'd like

I'm not sure what the best tools are for building documentation sites, so this will require a bit of research.

Describe alternatives you've considered

We could leave as is and just always recommend going to the latest version, but that will become less and less a viable option for all users as adoption increases.

Additional context

No response

@timsaucer timsaucer added the enhancement New feature or request label Dec 26, 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