Refresh native workflow orientation and planning status
This commit is contained in:
31
README.md
31
README.md
@@ -8,25 +8,26 @@ and spell casts.
|
||||
|
||||
## Quickstart
|
||||
|
||||
Provide an OpenRouter API key through the environment, then run the maintained
|
||||
minimal example:
|
||||
Set `OPENROUTER_API_KEY` in your environment, then run the maintained
|
||||
[minimal example](examples/dnd-minimal/config.yml) with its synthetic transcript:
|
||||
|
||||
~~~
|
||||
OPENROUTER_API_KEY=your-api-key \
|
||||
go run ./cmd/notarius run dnd-session \
|
||||
--config examples/dnd-minimal.config.yml \
|
||||
--input examples/seriatim-minimal-transcript.json
|
||||
go run ./cmd/notarius run dnd-session \
|
||||
--config examples/dnd-minimal/config.yml \
|
||||
--input-file examples/dnd-minimal/transcript.json
|
||||
~~~
|
||||
|
||||
The command publishes a JSON output bundle. Its command syntax and exit
|
||||
This makes model calls and publishes domain JSON artifacts. Command syntax and exit
|
||||
behavior are documented in the [CLI reference](docs/cli.md); configuration,
|
||||
credentials, and module selection are owned by the
|
||||
[configuration reference](docs/config.md).
|
||||
|
||||
For the complete ordered D&D workflow, use
|
||||
[the complete configuration](examples/dnd-complete.config.yml) with
|
||||
[its synthetic transcript](examples/dnd-complete-transcript.json). It
|
||||
demonstrates all implemented D&D lanes and the supporting campaign references.
|
||||
[the complete configuration](examples/dnd-complete/config.yml) with
|
||||
[its synthetic transcript](examples/dnd-complete/transcript.json). It
|
||||
demonstrates all implemented D&D lanes, ordered generated references, native
|
||||
resource customization, and optional source auxiliaries. See the
|
||||
[complete workflow](docs/consumers/dnd-pipeline.md) for invocation and discovery.
|
||||
|
||||
## Install A Source Release
|
||||
|
||||
@@ -53,8 +54,10 @@ Releases](docs/release.md).
|
||||
validation, and module selection.
|
||||
- [Operations](docs/operations.md) — output, state, recovery, and debug
|
||||
handling.
|
||||
- [Integration contracts](docs/integrations/) — Seriatim input and published
|
||||
artifact formats.
|
||||
- [Integration contracts](docs/integrations/) — Seriatim input, domain artifacts,
|
||||
and native [ConfigKit](docs/integrations/pkg-configkit.md),
|
||||
[PromptKit](docs/integrations/pkg-promptkit.md), and
|
||||
[CommandKit](docs/integrations/pkg-commandkit.md) boundaries.
|
||||
- [Subprocess consumer guide](docs/consumers/subprocess.md) — invoke Notarius
|
||||
from an orchestrator and consume a published result.
|
||||
- [Complete D&D consumer guide](docs/consumers/dnd-pipeline.md) — run the full
|
||||
@@ -63,8 +66,8 @@ Releases](docs/release.md).
|
||||
for maintainers.
|
||||
- [Developer guide](docs/development.md) — contributor orientation and
|
||||
validation guidance.
|
||||
- [Native migration roadmap](docs/roadmap/promptkit.md) — the planned PromptKit,
|
||||
ConfigKit, and CommandKit cutover.
|
||||
- [Native migration guide](docs/consumers/native-migration.md) — move existing
|
||||
configurations, invocations, and consumers to the native surface.
|
||||
- [Future work](docs/roadmap/future.md) — separate backlog of ideas and priorities.
|
||||
|
||||
Notarius is licensed under the [GPL v3.0 or later](COPYRIGHT).
|
||||
|
||||
Reference in New Issue
Block a user