mirror of
https://github.com/juanfont/headscale.git
synced 2026-01-11 20:00:28 +01:00
[Feature] Hope the development version documentation can be merged as soon as possible #1168
Reference in New Issue
Block a user
Delete Branch "%!s()"
Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?
Originally created by @wold9168 on GitHub (Dec 4, 2025).
Use case
I am currently working on some application development based on Headscale. I spent several hours reviewing the Tailscale API documentation. I saw the Headscale documentation for the version I was using, 0.27.1, on headscale.net, which did not mention Headscale's API. As a result, I subconsciously assumed that as an open-source implementation of a Tailscale server, Headscale's API should be consistent with the official Tailscale server. This took me a lot of time to debug until I realized Headscale uses a completely different set of standards than Tailscale. However, this information is only mentioned in the development version documentation and docs/ref/api.md, not in any prominent place.
I hope the development version documentation can be merged as soon as possible.
Description
There is a lack of API-related descriptive documentation on headscale.net (document version 0.27.1), especially the emphasis on the differences between the headscale and tailscale API standards.
Contribution
How can it be implemented?
No response
@nblock commented on GitHub (Dec 5, 2025):
Headscale's documentation is far from being complete and not all aspects are covered. We try to close the gap with the implementation and thus "version" the documentation with each release. The current "development" docs will be available with the release of 0.28.0.
@wold9168 commented on GitHub (Dec 5, 2025):
If the documentation in development cannot be merged yet, at least leave a warning about "headscale and tailscale use different APIs". What do you think?