Repository navigation
chore(docs): fix stale, wrong and duplicated docs - #6
Merged
Merged
Conversation
Several statements contradicted the code or the deploy files: the generation probe only stops an older module, the 1000-peer limit is close to the default descriptor limit, and Discover enforces file rules the README never listed. - README: the probe direction, the nofile requirement, the interface file rules. - apply.md: the exact name rule and the descriptor cost of a full apply. - overview: an empty diff skips awg set; locked decisions move to docs/architecture/README.md. - AGENTS: when the pre-commit hook runs format.sh, the TestSmoke version check, what the compiler actually enforces for the PSK, and the proto rule without a stale condition.
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
Several statements contradicted the code or the deploy files: the generation probe stops only an older module, the 1000-peer limit is close to the default descriptor limit, Discover enforces file rules the README never listed, and AGENTS.md described the pre-commit hook, the TestSmoke check and the PSK guarantee inaccurately.
What changed
nofilerequirement, the interface file rules.docs/architecture/apply.md: the exact name rule and the descriptor cost of a full apply.docs/architecture/overview.md: an empty diff skipsawg set; locked decisions move todocs/architecture/README.md.internal/node/discover.go: the name rule comment only.Verification
internal/node/discover.go,internal/node/probe.go,internal/server/management.go,scripts/git-hooks/pre-commit,test/smoke/smoke_test.go,deploy/compose.example.yml).scripts/format.shpasses.Per-task commits before collapse