Repository navigation
Conversation
why: The libtmux.org design system asks five rules of WRITING.md (12-contract-changes.md) that the site now implements: code frames that state their role, behaviour facts with source lines, equivalence tables that separate a recorded absence from an unmapped port, interface states that say what failed and what still works, and two named language labels. Without them in the writing guide, the next change has no rule to follow. what: - Voice: say "programming language" and "translation language" in interface labels, never the bare "Language" - Who you are writing for: equivalence tables name recorded differences and write "Not mapped" when no mapping exists - Documented examples that run: every code frame states its role (excerpt with file and line range, complete program with files, setup and output) - API documentation: documented completion, ownership, errors, transport and tmux requirements become behaviour facts with their source line - Error messages and help: interface states name what failed, what still works, and the next place to go
why: The libtmux.org design system asks three additions to AGENTS.md (12-contract-changes.md): where visual tokens and component anatomy are defined, that values become named custom properties, and which checks cover badge colour and layout changes. what: - Which policy applies: name the design system (libtmux/design) for visual tokens, component anatomy and page-family rules - Change discipline: add values as named custom properties, never literal colours in component styles - Change discipline: run check-style-parity for badge, signature and kind colours, and the layout-shift probe for player, tab, filter and pane layout changes
This branch has not been deployed
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.
The libtmux.org design system proposes five additions to
WRITING.mdand three toAGENTS.md(its12-contract-changes.md). The site implements the rules on thefeat/design-systembranch; this puts them in the contracts so later changes follow them.WRITING.md
AGENTS.md
site/src/stylesandsite/src/components.site/scripts/check-style-parity.mjs; player, tab, filter and pane layout changes run the layout-shift probesite/scripts/check-page-readiness.mjs.Not proposed by the design system: changes to repository boundaries, merge rules, the TypeScript pin or the framework policy.