Skip to content

Commit

Permalink
docs(installation): Clean up URLs
Browse files Browse the repository at this point in the history
  • Loading branch information
oliversalzburg committed Dec 21, 2023
1 parent db54c46 commit fd05a7b
Showing 1 changed file with 6 additions and 4 deletions.
10 changes: 6 additions & 4 deletions packages/documentation/docs/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,27 +8,27 @@

The file you need to put into your userscript manager is available from the [Releases page](https://github.com/kitten-science/kitten-scientists/releases) of KS. You can also

KS is released in 3 variants. For each variant we have a _stable_ URL that never changes, and points to the actual release `.js` file. For convenience, you can load that directly in your userscript manager, or you can download the specific version you want, without the indirection. If you're unsure, pick the shorter URL.
KS is released in 3 variants:

1. The **latest stable** release.

This is a release with a familiar version number, that has been designated as a reasonably stable version to use. At this time, that is:

<https://kitten-science.com/stable.js><https://github.com/kitten-science/kitten-scientists/releases/tag/v2.0.0-beta.7>.
<https://github.com/kitten-science/kitten-scientists/releases/tag/v2.0.0-beta.7>

1. The **nightly** release.

This release is built each night, if any changes have been made to the source code since the last nightly build.

These builds usually have a time stamp in their filename, like `20230103`, which designates the night they were built on.

<https://kitten-science.com/nightly.js><https://github.com/kitten-science/kitten-scientists/releases/tag/nightly>
<https://github.com/kitten-science/kitten-scientists/releases/tag/nightly>

1. The **latest** release.

This is built after every single change to the codebase. It should be considered highly unstable and experimental, although it usually isn't.

<https://kitten-science.com/dev.js><https://github.com/kitten-science/kitten-scientists/releases/tag/latest>
<https://github.com/kitten-science/kitten-scientists/releases/tag/latest>

For each of these releases on GitHub, you will usually find 2 important files:

Expand All @@ -51,6 +51,8 @@ To use bookmarklets, just create a new bookmark in your browser and enter the te
javascript:(function(){var d=document,s=d.createElement('script');s.src='https://kitten-science.com/stable.js';d.body.appendChild(s);})();
```

This bookmarklet uses <https://kitten-science.com/stable.js>, the stable release. You can also replace that URL with the [nightly](https://kitten-science.com/nightly.js) or [development](https://kitten-science.com/dev.js) build.

## Container

!!! warning
Expand Down

0 comments on commit fd05a7b

Please sign in to comment.