Open krader1961 opened 4 years ago
xiaq
commented
4 years ago Docs for the last release can perhaps be served from a different domain, say https://release.elv.sh/
After 1.0 this should be flipped around: https://elv.sh/ serving the last release, while https://head.elv.sh/ serving HEAD.
krader1961
commented
4 years ago Docs for the last release can perhaps be served from a different domain, say https://release.elv.sh/
I've been thinking about this and can't find a good way to make the docs for the unreleased master branch and specific release branches available from the same https://elv.sh/ root without introducing something like subdomains. Alternatively, anchor each document set at different path prefixes. I say "one or more" because it's an open question whether just the docs for the most recent release, or all releases, should be accessible. What about a structure like this:
| URL prefix | content |
|---|---|
https://elv.sh/ |
most recent release; e.g., 0.13.1 |
https://elv.sh/master |
master branch |
https://elv.sh/release/0.13.1 |
release 0.13.1 |
https://elv.sh/release/0.13.0 |
release 0.13.0 |
https://elv.sh/release/0.12.0 |
release 0.12.0 |
The "root" document at each of those URL prefixes would include links (and appropriate verbiage) to https://elv.sh/master and https://elv.sh/release. The latter being an index page with a link to the docs for each release.
This comment notes that the online reference documentation talks about features (e.g.,
str:join) not found in the most recent release. Ideally the web site would support viewing the docs for all releases, or at least the most recent release (e.g., 0.13.1), and the docs for the master branch. If that isn't practical then at a minimum the web site should be clearer about the version of the source the docs are based on.