Repository navigation
Docs: No em-dash, uv/ppp/tcl examples only, and a house style note - #78
Merged
Merged
Conversation
Three of the maintainer's instructions (2026-10-03), relayed by the ecosystem lead: - No em-dash anywhere in documents or code. All 122 lines that had one are rewritten by context (two sentences, a comma, a colon or parentheses), English and Korean alike; the en-dash in ranges stays. AGENTS.md section 17 makes it a rule. - Install and run examples use only uv, ppp (pypackpack) and tcl (toolchain-lite): `uv add --prerelease allow pythonx-compose`, then `ppp core add "pythonx-compose==0.1.0a1"` and `tcl install pythonx-compose`; tests and scripts run with `uv run`. The status FAQ asks "Can I install it from PyPI?" instead of naming pip. Records of what was run are rephrased so they are not instructions. AGENTS.md section 17 makes it a rule; the 0.1.0a1 Release notes stay as they are, a record. - The maintainer named this repository's guide the reference for every repository's documentation, so its style is written down in docs/style/writing.md (voice, the English/Korean pairing and registers, terms, mechanics), and AGENTS.md section 17 points at it. Also fixed: the Korean getting-started line said 230 tests pass where the English says 251. The em-dash and example passes were drafted by a subagent in a worktree and reviewed here; the style note is written here. documentation corrected: AGENTS.md, PROJECT.md, README.md, README_ko.md, INTENT, SPEC, every guide page and its CSS comment; added docs/style/writing.md. git grep finds no em-dash. check_guide: 0 findings. Tests unchanged. Refs #77
This was referenced Oct 3, 2026
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.
Closes #77
uv add --prerelease allow pythonx-composeanduv run .... AGENTS.md §17 rule; the 0.1.0a1 Release notes stay as a record.docs/style/writing.mdsets the reference for every repository's docs: voice, the English/Korean pairing (합니다체 for user-facing text, 한다체 for internal records), terms and mechanics.Drafted partly by a subagent; reviewed here.
check_guide: 0 findings. Tests are unchanged.