7 Commits

Include renames

Author	SHA1	Message	Date
github-actions[bot]	8548583f0e	docs: raise 3 docs requirement floors	2026-09-28 07:28:19 +02:00
Florian Preinstorfer	f3512d50df	Switch to mkdocs-materialx ... The project mkdocs-material is in maintenance-only mode and their successor is not ready yet. Use the modern, refreshed theme and drop the pymdownx.magiclink extension.	2026-03-25 22:30:03 +01:00
Florian Preinstorfer	44456497b0	Add versioned documentation ... Setup mike to provide versioned builds of the documentation. The goal is to have versioned docs for stable releases (0.23.0, 0.24.0) and development docs that can progress along with the code. This allows us to tailor docs to the next upcoming version as we no longer need to care about diversion between rendered docs and the latest release. Versions: * development (alias: unstable) on each push to the main branch * MAJOR.MINOR.PATCH (alias: stable, latest for the newest version) * for each "final" release tag * for each push to doc maintenance branches: doc/MAJOR.MINOR.PATCH The default version should the current stable version. The doc maintenance branches may be used to update the version specific documentation when issues arise after a release.	2024-12-02 16:51:50 +01:00
nblock	dc17b4d378	Documentation dependencies (#2252) ... * Use a trailing slash recommended by mkdocs-material * Update doc requirements Let mkdocs-material resolve its imaging dependencies (cairosvg and pillow) and fix a dependabot warning along the way. Reference compatible versions by major.minor.	2024-11-22 16:52:36 +00:00
nblock	8c7d8ee34f	Restructure headscale documentation (#2163) ... * Setup mkdocs-redirects * Restructure existing documentation * Move client OS support into the documentation * Move existing Client OS support table into its own documentation page * Link from README.md to the rendered documentation * Document minimum Tailscale client version * Reuse CONTRIBUTING.md" in the documentation * Include "CONTRIBUTING.md" from the repository root * Update FAQ and index page and link to the contributing docs * Add configuration reference * Add a getting started page and explain the first steps with headscale * Use the existing "Using headscale" sections and combine them into a single getting started guide with a little bit more explanation. * Explain how to get help from the command line client. * Remove duplicated sections from existing installation guides * Document requirements and assumptions * Document packages provided by the community * Move deb install guide to official releases * Move manual install guide to official releases * Move container documentation to setup section * Move sealos documentation to cloud install page * Move OpenBSD docs to build from source * Simplify DNS documentation * Add sponsor page * Add releases page * Add features page * Add help page * Add upgrading page * Adjust mkdocs nav * Update wording Use the term headscale for the project, Headscale on the beginning of a sentence and `headscale` when refering to the CLI. * Welcome to headscale * Link to existing documentation in the FAQ * Remove the goal header and use the text as opener * Indent code block in OIDC * Make a few pages linter compatible Also update ignored files for prettier * Recommend HTTPS on port 443 Fixes: #2164 * Use hosts in acl documentation thx @efficacy38 for noticing this Ref: #1863 * Use mkdocs-macros to set headscale version once	2024-10-10 15:24:04 +02:00
Juan Fontandohdearaugustin	68503581a0	Add test stage to docs (#1893) ... * Add test stage to docs Add new file with docs tets Run only in pulls * set explicit python version * Revert "set explicit python version" This reverts commit 4dd7b81f26. * docs/requirements: update mkdocs-material --------- Co-authored-by: ohdearaugustin <ohdearaugustin@users.noreply.github.com>	2024-04-21 16:33:22 +02:00
Azamat H. Hackimov	4c608a4b58	Fix Github Actions docs pipeline (#1622)	2023-11-29 15:11:00 +01:00