Docs: gotchas guide + declarative translation-rules design#27
Merged
Conversation
Two gaps from a documentation pass: - docs/gotchas.md collects the sharp edges that were previously only implicit: the camelCase field requirement (and that unknown fields are silently dropped), lossy-by-design translation + extensions.* passthrough, priority direction/range, container+script coexistence, JobSet for multi-role K8s, install-channel caveats, and the gitignored corpus. - docs/translation-rules.md specs the planned declarative rules file (letting users adjust translations without patching source) before it is built, so the feature ships with docs rather than after. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_016PnTz6Zxqa4jHocK8kCbyx
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.
Fills two documentation gaps found in a docs pass:
extensions.*passthrough,--report), priority direction +--priority-range, container+script coexistence, JobSet for multi-role K8s, install-channel caveats, and the gitignored corpus.New files only — no conflicts with the in-flight PRs. A follow-up will stitch
--priority-range, the pairs scraper mode, and doc cross-links into the README once #23/#25/#26 land.🤖 Generated with Claude Code