Repository navigation
docs,openspec: restructure user documentation into docs/ - #6
Merged
Merged
Conversation
README.md had grown to about 625 lines and mixed tutorial, how-to, reference, explanation and contributor material, with no path from "what is this" to a first alert and no single place for the config schema, metrics or flags. Split it into docs/ along the Diataxis quadrants: a first-monitor tutorial, how-to guides (deploy, ACLs, remote subnets, Slack and webhook sinks, heartbeat, monitor UI, troubleshooting), reference pages (config, CLI, checks, metrics, payload), explanation pages (failure layers, alert state, incidents and queues, monitor UI risks), and contributor pages for the live notification test and releases. Trim README.md to an overview, a quickstart and links. Check each documented metric name against the registrations, and the flags against --help. Ship docs/ in the release archives, add a Documentation section to the release-please changelog, and point scripts/live-stack.sh at the moved live-test page. Note the docs layout in CLAUDE.md. Archive the add-user-documentation change. It has no spec deltas. Updates tailscale/tailscale#5967 Signed-off-by: Richard Shade <rshade98@hotmail.com>
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.
README.md had grown to about 625 lines and mixed tutorial, how-to, reference, explanation and contributor material, with no path from "what is this" to a first alert and no single place for the config schema, metrics or flags.
Split it into docs/ along the Diataxis quadrants: a first-monitor tutorial, how-to guides (deploy, ACLs, remote subnets, Slack and webhook sinks, heartbeat, monitor UI, troubleshooting), reference pages (config, CLI, checks, metrics, payload), explanation pages (failure layers, alert state, incidents and queues, monitor UI risks), and contributor pages for the live notification test and releases. Trim README.md to an overview, a quickstart and links.
Check each documented metric name against the registrations, and the flags against --help. Ship docs/ in the release archives, add a Documentation section to the release-please changelog, and point scripts/live-stack.sh at the moved live-test page. Note the docs layout in CLAUDE.md.
Archive the add-user-documentation change. It has no spec deltas.
Updates tailscale/tailscale#5967