Repository navigation
docs: rewrite README in English and sync it with the code - #16
Merged
Merged
Conversation
Translate the README to English and verify it against the current code: document the panel setup and account commands, the full CLI, the never-seen-device and outbox watchdog alerts, YouTube-ads-in-games handling, NetworkPolicy/ingress limits and the private GHCR image; mark session_start_merge_seconds as unused; fix quiet_hours default and quoted notification strings; replace a child's name in examples with placeholders. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.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
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.
Translates the README to English and checks every claim against the current code.
Corrections and additions:
engine.session_start_merge_secondsis documented as unused (session confirmation replaced it), as isconfirm_burst_events.engine.quiet_hourshas no default in code (21:30–07:00 comes from the example config).uzywa iPada w nocy,nie zglasza sie do DNS).panel.enabled,npm run build,user-add,cookie_secure), account commands, the full CLI table (summary,tv,unifi,device,device-watch,user-*),KIDWATCH_STORE_PATH,notifications_retention_days, NetworkPolicy, ingress rate limits and aliases, the private GHCR image (ghcr-pull), and the front-end checks in CI.<device>/<child>placeholders.docs/uruchomienie-od-zera.mdis unchanged and still in Polish.🤖 Generated with Claude Code