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

Include better information about documentation version #276

Open
matzipan opened this issue Feb 9, 2020 · 3 comments
Open

Include better information about documentation version #276

matzipan opened this issue Feb 9, 2020 · 3 comments

Comments

@matzipan
Copy link

matzipan commented Feb 9, 2020

Currently, while looking at valadoc for a specific library, it's unclear to which version of the library this documentation corresponds to. Sometimes methods get added, removed or changed between versions and it's hard to check if the valadoc manages your specific version.

Easy solution: display version information in the documentation.

Comprehensive solution: generate valadocs over multiple releases of the libraries, so you can navigate between them, similar to the way the python handles its core API documentation. This approach could also generate a diff of what has changed between two different versions.

@stsdc
Copy link

stsdc commented Nov 12, 2022

Hi @ricotz @tintou @colinkiama ! Are there any major blockers for this? At least simple label about version would be enough 🥺

@tintou
Copy link
Member

tintou commented Nov 14, 2022

@stsdc No major blocker, feel free to start working on this 😉

@stsdc
Copy link

stsdc commented Nov 14, 2022

Sure I can try 👍
But what you suggest to start from? Because that's a new thing for me 😅

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

4 participants