Skip to content

Website: guides and glossary catch up with spec 0.4 (audit, #257, #262) - #266

Merged
mpigsley merged 13 commits into
mainfrom
docs/website
Nov 2, 2026
Merged

mpigsley merged 13 commits into
mainfrom
docs/website

Conversation

@mpigsley

@mpigsley mpigsley commented Nov 2, 2026 •

Copy link
Copy Markdown
Contributor

Fixes the website audit (docs-audit/website.md, 43 findings) against current main, and covers what #257 and #262 mean for app developers. Website only, so no changeset.

Per file

  • guides/other-characters.md
    • Auras: the sample now uses 5E's Aura of Protection on an ally statted with the same pack (the old one put a Draw Steel aura on a 5E goblin). Shows the real entry (the copy that holds it, paladin), gives each placed entry an ID and shows its removal, and names the aura's text key.
    • appliers on all five calls, with applyChanges' positional order (7th, after strict, links, dice).
    • Event samples keep the observer's and the talent's returned files; a bullet says why (offers live in the file).
    • Handoffs: an action effect without as runs on the actor, pausing at its path.
    • Turns: pass links and appliers. Cast auras: "orc-2e's bless or 5E's Spirit Guardians".
    • Both samples were run against the current engine (scratch scripts, not in the repo): the aura entry, the save going from 2 to 4 with the view, removeEffect, and the tactician's mark-damaged-1 stored in its file.
  • guides/showing-text.md: addedParam/addedParamValue/addedParamDescription in the Forms sample, templateFieldDescription, a "Situational choices" section (situational, situationalValue), an "Effects and auras" section saying plainly there is no aura helper (look up <source>.auras.<aura>.name with text.message, fall back to the source's name), stepPrompt/stepName, and invalid-param/boundBy text. Outputs checked with the text package.
  • guides/changing-characters.md: the five missing change types (finishCreation, offerFollowUp, clearFollowUp, dismissFollowUp, observe) with links; applyEffect names appliedBy and aura; naming offered reactions; a held copy's state from a choice's cost doesn't clamp (Spec: a situational choice's changes reach held copies' state (#244) #257).
  • guides/storing-characters.md: appliedBy, aura, state on applied entries and entry on addAs: copy picks; caches depend on links and appliers.
  • guides/showing-a-sheet.md: auras and observes rows; effectsWhen; aura immunity issue IDs; re-key competing picks saved under rules/… (Spec: rules choice issue IDs name their pack, unchoose by owner, list of integer #240).
  • guides/text-and-translation.md: key rows for added parameters, content computed values, auras, inline option descriptions, and a rules-level choice's issue (<pack>:rules/<choice>); {self_<key>} covers computed values; invalid-param and boundBy in errors.
  • guides/upgrading-characters.md: changeContentType and grantsToCopies, grant-not-copied, and a "What your app passes in" section (removed or narrowed parameters and situational choices, parameters made derived; a removed parameter's value is ignored, checked against the engine).
  • guides/rolling-dice.md: "PF2e's Hero Points" becomes "orc-2e's Hero Points"; bounds that read params aren't listed; derived parameters are never passed and participant errors come first (Spec: derived parameters, computed values in action-time effects, bounds on an action's own parameter (#251, #252) #262); continue a paused action with the ruleset it started with; roll items' tags.
  • guides/building-characters.md: picked-copy-invalid; rules-level choice issue IDs.
  • guides/implementing.md, quick-start.md, README.md: level 6 covers shared sheets, auras, turns and events; level 5 lists describeAction; "no runtime dependencies" becomes "doesn't depend on Node" (the engine depends on @opencharacter/spec and semver).
  • guides/packs-and-rulesets.md: LicenseRef- packs (Draw Steel, the Sine Nomine games) carry a credit and a permission notice.
  • glossary.md: new Activation, Added parameter (with addedBounds/boundBy), Shared action; updated Effect operation (action), Handoff, Interface change, Shape change, Proposed change, Situational choice (held copy costs).
  • scripts/sync-docs.ts (separate commit): the home packs table names LicenseRef-draw-steel-creator-license and LicenseRef-sine-nomine-free-edition, drops the unused OGL-1.0a, and adds a footnote.

Skipped

Checks

pnpm check, pnpm build:website (2008 internal links, 0 broken) and pnpm release:check pass.

Signed-off-by: Mitchel Pigsley <mpigsley@gmail.com>
…all, keep the observer's file

Signed-off-by: Mitchel Pigsley <mpigsley@gmail.com>
…es, step text, parameter errors

Signed-off-by: Mitchel Pigsley <mpigsley@gmail.com>
…d-copy costs don't clamp

Signed-off-by: Mitchel Pigsley <mpigsley@gmail.com>
…pend on links and appliers

Signed-off-by: Mitchel Pigsley <mpigsley@gmail.com>
… re-keying rules-level option IDs

Signed-off-by: Mitchel Pigsley <mpigsley@gmail.com>
…ues, auras, inline options, rules-level choice issues

Signed-off-by: Mitchel Pigsley <mpigsley@gmail.com>
…d, removed parameters and situational choices

Signed-off-by: Mitchel Pigsley <mpigsley@gmail.com>
… bounds, replay needs the same release, item tags

Signed-off-by: Mitchel Pigsley <mpigsley@gmail.com>
…issue IDs

Signed-off-by: Mitchel Pigsley <mpigsley@gmail.com>
…on, the engine's dependencies

Signed-off-by: Mitchel Pigsley <mpigsley@gmail.com>
Signed-off-by: Mitchel Pigsley <mpigsley@gmail.com>
…peration, handoff, interface and shape change, proposed change

Signed-off-by: Mitchel Pigsley <mpigsley@gmail.com>
@mpigsley
mpigsley requested a review from a team as a code owner November 2, 2026 18:08
@mpigsley
mpigsley merged commit f8a124a into main Nov 2, 2026
8 checks passed
@mpigsley
mpigsley deleted the docs/website branch November 2, 2026 18:13
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