Repository navigation
chore(docs): fix stale, wrong and duplicated docs - #7
Merged
Merged
Conversation
The docs drifted from the code after the Xray backend landed: the example compose ran v0.1.0, which has no Xray backend, the x-usher example failed validation, and the same rules lived in two or three places with different values. - README is a front page: process wiring, users, the data directory, running, short AmneziaWG and Xray sections. The Xray reference moves to docs/xray.md, isolation, DNS and new keys to docs/operations.md. - Facts are checked against the code: env dependencies, name rules, Hysteria2 and trust: pin requirements, drift behaviour, one inbound failure table. - overview describes the pass for both backends; locked decisions move to docs/architecture/README.md. - Release notes, test timings, dates and lock-file mechanics leave the living docs; compose specifics stay in compose comments. - The example compose runs usher v0.2.0.
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
1 participant
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.
Problem
The docs drifted from the code after the Xray backend landed. The example compose ran usher v0.1.0, which has no Xray backend; the
x-usherexample failed validation; env dependencies were missing; the same rules lived in two or three places with different values; README carried release notes, test timings and lock-file mechanics.What changed
docs/xray.md; isolation, DNS and new keys todocs/operations.md.docs/architecture/overview.mddescribes the pass for both backends; locked decisions move todocs/architecture/README.md.deploy/compose.example.ymlruns usher v0.2.0 and documents the port rule in comments.Verification
cmd/usher/env.go,internal/xray/*,internal/pass/pass.go,internal/config/config.go,release.yml).usher.ymlexample passesconfig.Load.scripts/format.shpasses.Per-task commits before collapse