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

Docs: Better handling of API changes across different API versions. #183

Open
Abscissa opened this issue May 4, 2018 · 1 comment
Open
Labels

Comments

@Abscissa
Copy link

Abscissa commented May 4, 2018

Related to #182, it would be nice to have a tool/mechanism by which no-longer-existing docs pages are replaced by a page that says something like "This symbol no longer exists in this version of the library. The last version it which had it was vX.Y.Z (linked to the appropriate archived page). It has been replaced with XYZ (link to appropriate page in current docs.)"

Further, it would also be nice for the documentation of older versions to be updated with things like "You are viewing an archived from an older version of this library. The latest version is vX.Y.Z (linked to same page in latest version of docs."

Summaries of the history of API changes would be nice, etc.

Also, could use ability to issue documentation updates/fixes for already-released versions.

Really, what's needed is a whole new documentation system, hopefully built on top ddox, or maybe forked from it.

@Abscissa Abscissa added the docs label May 4, 2018
@Marenz
Copy link

Marenz commented May 6, 2018

Possibly helpful and related: The release tool used by sociomantic: https://github.com/sociomantic-tsunami/neptune

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

No branches or pull requests

2 participants