Skip to content

Commit 5c473c0

Browse files
committed
Expand glossary and codify site source rules
1 parent e7df783 commit 5c473c0

File tree

2 files changed

+24
-0
lines changed

2 files changed

+24
-0
lines changed

AGENTS.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -149,6 +149,13 @@ List only the skills this repository should actively use.
149149
- Durable repository documentation lives in `docs/`.
150150
- SDK-specific architecture, ADRs, and language rollout docs live in `SDK/docs/`.
151151
- Runtime-facing usage docs live in `SDK/README.md` and `SDK/<Language>/README.md`.
152+
- Site pages must be generated from canonical checked-in source documents instead of hand-maintained duplicated prose inside the site builder.
153+
- Preferred source mapping:
154+
- `/` from `README.md`
155+
- `/glossary/` from `docs/Glossary.md`
156+
- `/sdk/` from `SDK/README.md` plus `SDK/manifest.json`
157+
- `/skills/` from `README.md` AI Skills content and the canonical files under `Skills/`
158+
- If a page needs copy that does not fit an existing source document, add a dedicated versioned markdown source file first and generate from that file.
152159
- GitHub Actions workflows stay compact by delivery surface:
153160
- `.github/workflows/ci.yml` for SDK quality, runtime build/test, and coverage stages
154161
- `.github/workflows/pages.yml` for site publishing

docs/Glossary.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,8 +43,16 @@ It is intended to be complete for the current TPS specification, including headi
4343
| **Breath Mark** | A `[breath]` marker that indicates a natural breathing point without adding display time. |
4444
| **Emotion** | A named delivery profile such as `warm`, `urgent`, or `focused`. |
4545
| **Emotion Preset** | A predefined emotion value recognized by the TPS validator and compiler. |
46+
| **Vocal Archetype** | A composite delivery persona such as `Friend`, `Motivator`, `Educator`, `Coach`, `Storyteller`, or `Entertainer`. |
47+
| **Archetype Profile** | The expected delivery ranges attached to a vocal archetype, including speed, articulation, energy, melody, and volume tendencies. |
4648
| **Emphasis** | A visual and delivery emphasis span created by tags such as `[emphasis]`, `*text*`, or `**text**`. |
4749
| **Highlight** | A presentation tag such as `[highlight]...[/highlight]` that increases visual prominence without changing timing. |
50+
| **Articulation** | The way words connect during delivery, expressed in TPS as styles such as `legato` or `staccato`. |
51+
| **Articulation Tag** | An inline tag such as `[legato]...[/legato]` or `[staccato]...[/staccato]`. |
52+
| **Energy** | A delivery intensity level on the TPS 1–10 scale. |
53+
| **Energy Tag** | An inline tag such as `[energy:7]...[/energy]` that sets energy level for a span. |
54+
| **Melody** | A pitch-variation or inflection level on the TPS 1–10 scale. |
55+
| **Melody Tag** | An inline tag such as `[melody:8]...[/melody]` that sets melodic contour for a span. |
4856
| **Volume Level** | A loudness modifier such as `loud`, `soft`, or `whisper`. |
4957
| **Volume Tag** | An inline tag that applies a volume level to a span of text. |
5058
| **Delivery Mode** | A delivery-shaping tag such as `aside`, `rhetorical`, `sarcasm`, or `building`. |
@@ -74,6 +82,9 @@ It is intended to be complete for the current TPS specification, including headi
7482
| **Unknown Tag** | An inline tag that is not part of the TPS contract and should be reported by validation logic. |
7583
| **Malformed Tag** | A tag-like construct with invalid syntax, for example a broken closing tag or invalid pause payload. |
7684
| **Unknown Header Token** | A segment or block header parameter that is not recognized as name, speed, emotion, timing, or speaker. |
85+
| **Unknown Archetype** | A header `Archetype:Name` value that is not part of the closed TPS archetype set. |
86+
| **Archetype Warning** | A non-fatal validation result emitted when inline delivery tags conflict with the expected profile of an archetype. |
87+
| **Rhythm Analysis Warning** | A non-fatal validation result emitted when phrase length, pause density, emphasis density, or speed variation diverge from an archetype’s expected rhythm profile. |
7788

7889
## Compiler And Player Terms
7990

@@ -84,9 +95,13 @@ It is intended to be complete for the current TPS specification, including headi
8495
| **Parser** | The TPS component that turns markdown TPS text into a structured document model. |
8596
| **Compiler** | The TPS component that converts a parsed document into a timed, JSON-friendly playback model. |
8697
| **Compiled Script** | The full compiled output containing metadata, segments, blocks, phrases, words, and total duration. |
98+
| **Compiled JSON** | The serialized JSON form of a compiled TPS state machine used for storage, transport, and cross-runtime restore. |
8799
| **State Machine** | The compiled playback model that lets a runtime resolve what should be visible at a given elapsed time. |
88100
| **Player** | The runtime component that reads the compiled script and returns the current presentation state. |
101+
| **Playback Session** | The stateful runtime component that owns a timer loop and exposes play/pause/seek/navigation commands plus runtime events. |
102+
| **Standalone Player** | A higher-level runtime component that can compile TPS source or restore compiled JSON and expose one embeddable playback surface. |
89103
| **Presentation Model** | The player output describing the active segment, block, phrase, visible words, active word, and remaining time. |
104+
| **Snapshot** | The bindable runtime view-model emitted by playback sessions or standalone players for host UIs. |
90105
| **Current Word Index** | The zero-based index of the active compiled word, or `-1` when no active word exists. |
91106
| **Elapsed Time** | The playback time passed into a player when resolving the current presentation model. |
92107
| **Remaining Time** | The difference between compiled duration and elapsed playback time. |
@@ -103,3 +118,5 @@ It is intended to be complete for the current TPS specification, including headi
103118
| **Runtime Matrix** | The CI-generated list of enabled runtimes used for build, test, and coverage workflows. |
104119
| **Shared Fixtures** | Canonical test inputs and runtime expectations stored under `SDK/fixtures/`. |
105120
| **Parity** | The requirement that all active SDKs expose the same TPS contract: constants, validation, parser, compiler, and player APIs. |
121+
| **TimeProvider** | The .NET time abstraction used by TPS playback sessions when a host needs deterministic or externally controlled playback timing. |
122+
| **EventSynchronizationContext** | The .NET dispatcher target used to marshal playback events back onto a UI thread or host synchronization context. |

0 commit comments

Comments
 (0)