eric/notarius
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Document completed DnD shared helper refactor

Browse Source
This commit is contained in:
Eric Rakestraw
2026-07-06 17:26:38 +00:00
parent 9b2d0297b7
commit 671ff6d132
4 changed files with 50 additions and 437 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
docs/internal/modules.md
View File

@@ -42,11 +42,13 @@ rendered reference bytes.
LLM-backed modules own Scriptorium prompt definitions and response schemas in
their embedded assets. Module-owned prompts live under each module's shallow
`assets/prompts` tree and schemas live under `assets/schemas`. Shared reusable
prompt fragments live under `internal/modules/sharedassets`. Module contracts
should expose prompt IDs, versions, input material names, and non-secret
prompt/schema hashes through manifest metadata; they should not expose
Scriptorium public types through chunk, extract, or normalize contracts.
`assets/prompts` tree and schemas live under `assets/schemas`. Generic shared
prompt filesystem composition lives under `internal/modules/sharedassets`.
Common D&D prompt fragments, reference slot helpers, prompt input assembly, and
reference rendering live under `internal/modules/sharedassets/dnd`. Module
contracts should expose prompt IDs, versions, input material names, and
non-secret prompt/schema hashes through manifest metadata; they should not
expose Scriptorium public types through chunk, extract, or normalize contracts.
Chunk modules receive the structured LLM client, configured Scriptorium profile
ID, prompt session ID, and raw source input material through
@@ -107,8 +109,8 @@ session ID to the runtime; validates model-authored source-unit boundaries; and
converts each scene into a deterministic source chunk.
Its prompt definition lives under `assets/prompts` and its schema under
`assets/schemas`. Shared reusable prompt fragments are provided by
`internal/modules/sharedassets` and referenced from prompt definitions under
`assets/schemas`. Shared reusable D&D prompt fragments are provided by
`internal/modules/sharedassets/dnd` and referenced from prompt definitions under
`./sharedassets/`.
Requires:
@@ -146,8 +148,8 @@ spell-cast responses into artifact candidates; and supplies deterministic
validators.
Its prompt definition lives under `assets/prompts` and its schema under
`assets/schemas`. Shared reusable prompt fragments are provided by
`internal/modules/sharedassets` and referenced from prompt definitions under
`assets/schemas`. Shared reusable D&D prompt fragments are provided by
`internal/modules/sharedassets/dnd` and referenced from prompt definitions under
`./sharedassets/`.
Requires:

10
docs/internal/overview.md
View File

@@ -65,10 +65,12 @@ Each module package owns its contract implementation, module spec,
registration, options, focused tests, and module-specific errors.
Module-owned prompts and schemas live in each module's shallow `assets/prompts`
and `assets/schemas` directories. Shared reusable D&D prompt fragments live in
`internal/modules/sharedassets`.
and `assets/schemas` directories. Generic shared prompt filesystem composition
lives in `internal/modules/sharedassets`; shared D&D prompt fragments and
reference helpers live in `internal/modules/sharedassets/dnd`.
Shared asset package: `internal/modules/sharedassets`
Shared D&D helper package: `internal/modules/sharedassets/dnd`
## Fixtures And Tests
@@ -88,7 +90,9 @@ servers.
- Source-format details stay in input modules and integration docs.
- Extraction-domain details stay in extract modules and artifact docs.
- Shared prompt fragments stay in `internal/modules/sharedassets`.
- Generic shared prompt plumbing stays in `internal/modules/sharedassets`;
domain-specific shared prompt behavior stays with the relevant module helper
package.
- Provider wire details stay in the LLM runtime and provider integration docs.
- Durable output contracts belong in integration docs.
- Operator procedures belong in `docs/operations.md`, not internal docs.