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

Organize docs by major version, not minor #52

Closed
chapulina opened this issue Aug 13, 2020 · 3 comments
Closed

Organize docs by major version, not minor #52

chapulina opened this issue Aug 13, 2020 · 3 comments
Labels
infrastructure Requires changes on the web server or other infra

Comments

@chapulina
Copy link
Contributor

Currently, library docs are organized by their minor version. For example, this URL is specific to version 6.4, not to version 6:

https://ignitionrobotics.org/api/math/6.4/index.html

Since we don't break behaviour within a major version, and we often make minor releases, I think it would be more convenient to just separate documentation according to major version, instead of minor. If needed, a tutorial can mention from which minor version the feature is available. This way, in the case above, when we release ign-math 6.5, we don't need to release a whole new set of docs.

@chapulina chapulina added infrastructure Requires changes on the web server or other infra boost the docs labels Aug 13, 2020
@chapulina
Copy link
Contributor Author

Oh I think this is a duplicate of #47

@chapulina
Copy link
Contributor Author

Reopening because I think this one is more specific about not using minor versions for API docs.

@chapulina
Copy link
Contributor Author

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
infrastructure Requires changes on the web server or other infra
Projects
None yet
Development

No branches or pull requests

1 participant