Versioned API Documentation
FEATURE REQUEST
Include versioning in the new API documentation site.
Description of Request
Give version accurate documenation to users and allow them to see when endpoints were added or deprecated.
Reason or Need for Feature
The current Sia API documenation does not allow for different documentation for different Sia versions. This has been a problem in the past and will be a problem with the release of 1.4.0. Version 1.4.0 introduces many new API endpoints but version 1.3.7 is still supported.
Design / Proposal
I believe 3 ideas were discussed. Ordered by complexity.
- Have slate checkout and build the docs dynamically on the web server based on which docs the user requests.
- Allow the user to select which version or language of the docs they want to read. Readthedocs.io supports this feature. Check out the bottom of the left column. ReadTheDocs
- Simply put the Sia version number of when the API endpoint was added or deprecated. Godoc recently added this support. For example Golang
There has been some good discussion on Discord here: https://discordapp.com/channels/341359001797132308/347026783750717450/527982861198950430
Edited by Thomas Bennett