search

parse-community / Parse-SDK-Android

The Android SDK for Parse Platform
https://parseplatform.org/
Other
1.88k stars 735 forks source link

[feature request] Provide versioned javadoc for past releases #1060

Closed jhansche closed 2 years ago

jhansche commented 3 years ago

It would be useful if gh-pages contained a separate directory for each release, so that those of us generating documentation with Javadoc's linksOffline(), or Dokka's externalDocumentationLink, can link directly to the right version of docs. For example, if my SDK depends on version 1.19, but the API has changed since then, my javadoc links will stop working because the /api/ directory can only contain a single version.

Maybe if docs were generated in a structure like:

\
 - docs/
   \
    - current => 1.25.0/   (this is a symlink)
    - 1.25.0/
    - ...
    - 1.19.0/
    - ...

Then projects could link to the correct documentation for a given version, by referencing the javadoc link https://parseplatform.org/Parse-SDK-Android/docs/1.25.0/, and all symbols referenced from that project would Just Work™, even if a newer version is released later.

People looking to browse the current documentation would just link to /docs/current/, to see docs for the latest version.

mtrezza commented 2 years ago

We are looking to change the docs framework; your suggestion is a good feature requirement for the new framework we will choose.

See the forum discussion.