Repository navigation
docs: cut the README back to what a PR author needs - #10
Merged
Merged
Conversation
The auto-format docs had grown to 66 lines on a 25-line README -- app setup, approval-state semantics, required-check reasoning -- none of which someone editing policy.hujson needs. That is now one sentence: the comment has a checkbox, tick it or say /fmt. What was worth keeping moved to where its audience already is. The app setup and the approval behaviour go next to the secrets they describe in lint-fix.yml. The warning about workflow_dispatch goes beside the Test ACL step whose event gating is the reason it isn't safe. The note about the lint living inside the acls job was already a comment in tailscale.yml, so it's simply dropped. Also tidies a comment in lint-fix.yml that an earlier patch left mid-sentence. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
✅ Policy lint passed
Lint output
|
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.
My auto-format docs had grown to 66 lines on a 25-line README — app setup, approval-state semantics, required-check reasoning — none of which someone editing
policy.hujsonneeds to read. The README is back to 27 lines, and the new material is one sentence:The parts that were worth keeping moved to where their audience already is, rather than being deleted:
FMT_APP_ID/FMT_APP_PRIVATE_KEYinlint-fix.yml, which is where someone would be looking if they had to recreate the app.workflow_dispatchisn't a safe way to re-trigger a stale check → beside theTest ACLstep intailscale.yml, since that step's event gating is the actual reason.aclsjob → dropped, becausetailscale.ymlalready said it in a comment. That one was pure duplication.Also tidies a comment in
lint-fix.ymlthat an earlier patch of mine left mid-sentence ("runs without that click. When / the app secrets are present…").No behaviour change — comments and Markdown only.
🤖 Generated with Claude Code