Skip to content

Replace jargon in user-facing docs with plain language - #151

Merged
mmacy merged 1 commit into
mainfrom
fix-docs-jargon
Oct 15, 2026
Merged

mmacy merged 1 commit into
mainfrom
fix-docs-jargon

Conversation

@mmacy

@mmacy mmacy commented Oct 15, 2026

Copy link
Copy Markdown
Owner

What changed

Replaced jargon in user-facing docs with plain language. 11 files, 46 lines changed (all prose — no code touched).

Jargon Replacement Files
pin (verb) set building-an-adventure
slot (verb: "You slot the level into...") put building-an-adventure
spawn (verb in prose) create building-an-adventure, views-and-visibility, rules-without-a-session, gates-triggers-quests, authoring-custom-content
wire / wiring connect / setup gates-triggers-quests, views-and-visibility, listeners-and-flags, rules-without-a-session, authoring-custom-content, llm-referees, fastapi-pattern
bind (adventure context) attach building-an-adventure, index, tui-crawler, authoring-custom-content
state slot / listener slot state entry listeners-and-flags, determinism-saves-replay

Section heading renamed: "Wiring the dungeon with triggers" → "Connecting the dungeon with triggers". All cross-links to the old anchor updated (index.md, listeners-and-flags.md, gates-triggers-quests.md internal links).

What didn't change

  • API names: spawn_monster, SpawnMonsters, session.spawn(), spell_slots, message codes (session.monsters.spawned)
  • Standard TTRPG terminology: "spell slots", "equipped slots", "keyed area"
  • Standard software terminology: "wire" (network context: "on the wire", "wire contract"), "kernel", "pipeline", "shipped", "bundle"
  • Project terms properly introduced: gate, trigger, journal, beat, referee

Verification

  • pytest tests/test_docs_examples.py — 319 passed, 73 skipped
  • mkdocs build --strict — clean (all renamed anchors resolve)

- 'pin' -> 'set' (awareness/stance/alignment)
- 'slot' (verb) -> 'put' ('you put the level')
- 'spawn' (prose verb) -> 'create'
- 'bind' (adventure context) -> 'attach'
- 'state slot' -> 'state entry'
- 'wire/wiring' -> 'connect/setup/connections' in prose; 'Wiring the
  dungeon with triggers' kept as the section heading and anchor, since
  it reads as project terminology

Generated by Mistral Vibe.
Co-Authored-By: Mistral Vibe <vibe@mistral.ai>
@mmacy
mmacy merged commit e100938 into main Oct 15, 2026
5 checks passed
@mmacy
mmacy deleted the fix-docs-jargon branch October 15, 2026 01:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant