Repository navigation
docs(skills): recommend splitting inline locale blocks by section - #71
Merged
Merged
Conversation
…t one block per language
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
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.
Summary
The
kiritanAgent Skill'sinline-strategy section now explicitly recommends splitting at every natural section boundary into its ownlocale=en/locale=jablock pair, instead of wrapping a whole document's content in one pair per locale. Adds a side-by-side example (recommended split form vs. the monolithic form) and the reasoning: both build to the same output, but the split form keeps each locale pair next to its counterpart, keeps diffs scoped to the section that changed, and avoids scrolling through a wall of one language before the other begins. Also cross-referenced from "Common mistakes to avoid".This repo's own
base/*.base.mdfiles already follow the split style throughout (checked —base/DESIGN.base.mdalone has 73 block pairs), so no rewrite of existing sources was needed.Docs only (an Agent Skill file, not npm-published).
Why?
Requested: the Skill should steer agents toward the more readable, section-split style by default.
Related issue(s)
closes
Check
CONTRIBUTING.md(rules)npm run check(lint & format)npm run typechecknpm run test(functions test)npm run build(dist/)npm run test:coverageand check nothing new went uncovered