About this preview

This is an unofficial preview of the Shlink documentation, rebuilt with Sourcey, an open-source docs engine licensed under AGPL-3.0. It is not run by the Shlink project. Search engines are asked not to index it, and it comes down on request, or after 30 days.

What it is built from

• The website repository, shlinkio/shlink.io at 705517f, converted with sourcey migrate: all 46 pages at their addresses under /documentation, with every heading link still landing, in one sidebar sectioned as the site sections it.
• The REST API reference from shlink-open-api-specs, for 5.1.7, 4.6.0 and 3.7.4, with a release picker and each release on one page. Every link from the documentation to the specification site lands on its operation, including the removed QR code endpoint on 4.6.0’s.

Measured beside the current site

Both sites were built from their own sources and served side by side on one machine, compressed as hosts serve them. Each page was opened in a fresh browser at 1440 by 1000 pixels and measured once the network settled, on 21 October 2026 with Sourcey 3.8.3.

Search runs from static files the build writes: typing “redirect” downloads 39.9 KB the first time, and nothing after that, with no hosted service to apply for or keep. The current site’s search downloads 11.6 KB for each query from its hosted service.

The preview builds in 4.7 s from cold with the three API references, peaking at 1.16 GB of memory; the current site builds in 2.3 s, peaking at 1.32 GB. It writes 25.8 MB, of which 22.3 MB is what readers load (the current site writes 22.4 MB), most of it the site’s own media.

For agents

Every page and operation is also published as Markdown, with an llms.txt, a documents index, each release’s OpenAPI bundle, and ARD and API catalog discovery files.

A link on the current site that misses its section