Repository navigation
Rewrite the documentation and add a documentation website - #155
Merged
Merged
Conversation
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01SYRvoVjhBse7GtgbaHgrFD
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01SYRvoVjhBse7GtgbaHgrFD
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01SYRvoVjhBse7GtgbaHgrFD
An Astro site in website/ that renders docs/ under /tslink/ for GitHub Pages. The remaining pages get interim frontmatter until they are rewritten. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01SYRvoVjhBse7GtgbaHgrFD
Base path for icons, search and every internal link, a tslink home page and icon, and scripts/check-links.ts for the built site (--source for the Markdown as GitHub renders it). Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01SYRvoVjhBse7GtgbaHgrFD
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01SYRvoVjhBse7GtgbaHgrFD
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01SYRvoVjhBse7GtgbaHgrFD
The CHANGELOG's links to them now go to the pages they pointed at. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01SYRvoVjhBse7GtgbaHgrFD
The status-file warnings now list every key tslink writes, and the certificate page names the bundled Tailscale 1.104.4 as still lacking the plain-HTTP fix. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01SYRvoVjhBse7GtgbaHgrFD
docs/README.md mirrors the site's navigation, CONTRIBUTING.md says how the site is built and checked, and the examples link the right Tailscale page. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01SYRvoVjhBse7GtgbaHgrFD
docs/README.md mirrors the site's navigation, CONTRIBUTING.md says how the site is built and checked, the examples link the right Tailscale page, and the moved specs' links and the linter's exclusion follow the new path. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01SYRvoVjhBse7GtgbaHgrFD
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01SYRvoVjhBse7GtgbaHgrFD
…ges' links - architecture: only tslink's own refusals end the retries, not every refused tag - getting-started: list everything --grant-all-permissions grants - container-labels: the app-capabilities header is trustworthy only through Serve - README: host isolation holds by default, not unconditionally - the site's Markdown pages point links outside the docs at GitHub, and check-links now checks them - pages.yml runs on any Markdown change and never cancels a deploy Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01SYRvoVjhBse7GtgbaHgrFD
Biome runs over the whole workspace regardless of FILTER_REGEX_EXCLUDE and rejected the site's Tailwind CSS; website/biome.json turns it off there, as oxlint and oxfmt lint the site in pages.yml. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01SYRvoVjhBse7GtgbaHgrFD
…tovers The link checker now keeps a heading's inline code when it works out the anchor, and ignores href/src inside code. The table of contents, the search shortcut hint and the theme survive navigation with the client router, the structured data points at the tslink site, and lastModifiedFor uses the shared base and runs its git lookups once per build. Code tabs, card tables and the comments describing cetacean's API, demo and changelog are gone. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01SYRvoVjhBse7GtgbaHgrFD
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Rewrites tslink's user documentation and publishes it as a website at https://matchory.github.io/tslink/.
What changes
docs/STYLE.mdreplaces the Simplified Technical English rules with a direct, second-person voice that gives the reason next to the fact and names limits plainly. Every user page is rewritten in it: the tutorial, 7 guides, 7 reference pages, 4 explanation pages,examples/README.md, plusdocs/README.mdand parts ofCONTRIBUTING.md.docs/images/overview.svg), a comparison with the alternatives (sidecar, host Tailscale, tsnet), what tslink doesn't do, and an "independent project, not affiliated with Tailscale" line.website/is an Astro site adapted from cetacean's, built fromdocs/under the/tslinkbase path. It has search, light and dark themes, Markdown copies of each page,llms.txtand a sitemap. It publishes onlygetting-started.md,guides/,reference/andexplanation/, so the style guide, specs and any local files stay off it.website/scripts/check-links.ts(8 tests) checks the built site, its Markdown copies and the repository's Markdown as GitHub renders it, anchors included..github/workflows/pages.ymllints, type-checks, builds and checks links on every PR that touches docs, the site or any Markdown. It deploys only frommainor on manual dispatch. GitHub Pages is already enabled with GitHub Actions as its source./website, npm).specs/moves todocs/specs/. The two stub pagesdocs/credentials.mdanddocs/node-provisioning.mdare removed, and the CHANGELOG's links to them now go to the real pages.Docs that disagreed with the code or were wrong
container-labels.mdsaid several Services per container need v0.4.0. They shipped in v0.3.5.files-and-paths.mdlisted 4 status warnings. The code also writesnode-name,service/<svc>,ports/<svc>andcontrol/<svc>, which are now listed.https-certificates.mdsaid the plain-HTTP certificate fix (feature/acme: only refresh certs for HTTPS serve entries tailscale/tailscale#21736) isn't in 1.104.1. It isn't in the now-bundled 1.104.4 either.examples/README.mdlinked "Tailscale Service" to a page that redirects to the Kubernetes operator's egress docs. It now goes to the Services docs.The final review also found three statements the rewrite had made inaccurate; all are fixed:
--grant-all-permissionsgrants;Tailscale-App-Capabilitiesheader can be trusted.Verified
go test ./...andgolangci-lint run;website/:pnpm lint,fmt:check,check,test:links,build,check-linksandcheck-links --source;Merging deploys the site.
🤖 Generated with Claude Code
https://claude.ai/code/session_01SYRvoVjhBse7GtgbaHgrFD