Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 1 addition & 2 deletions docs/developer/01-architecture-overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ flowchart LR
## Canonical flow

1. Caller resolves/starts a session.
2. Caller sends action commands through `Agent.command/4`.
2. Caller sends action commands through `Jido.Document.Agent.command/4`.
3. Agent executes one action module with a normalized context.
4. Agent updates session state, history, revision, and audit metadata.
5. Agent emits session-scoped signals for subscribers.
Expand All @@ -68,4 +68,3 @@ flowchart LR
- Save is guarded by baseline snapshots to avoid silent overwrite.
- Signal payloads are versioned and bounded.
- Recovery is explicit (checkpoint discovery, recover, discard).

3 changes: 1 addition & 2 deletions docs/developer/02-supervision-and-runtime-topology.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# 02 - Supervision and Runtime Topology

`Jido.Document.Application` defines a small supervision tree with clear
The application entrypoint (`lib/jido/document/application.ex`) defines a small supervision tree with clear
separation between shared runtime services and dynamic session processes.

## Topology
Expand Down Expand Up @@ -48,4 +48,3 @@ checks (`PluginManager.startup_check/2`) and logs compatibility diagnostics.
- `one_for_one` supervision isolates process crashes.
- Session failures do not inherently crash sibling sessions.
- Registry and signal bus are shared services and should remain lightweight.

5 changes: 2 additions & 3 deletions docs/developer/05-rendering-and-preview-subsystem.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,8 +38,8 @@ flowchart TD
## Plugin model

- Contract:
- `Jido.Document.Render.Plugin.transform/2`
- `Jido.Document.Render.Plugin.compatible?/1`
- `c:Jido.Document.Render.Plugin.transform/2`
- `c:Jido.Document.Render.Plugin.compatible?/1`
- Manager behavior:
- ordered execution by priority
- startup compatibility checks
Expand All @@ -55,4 +55,3 @@ Render output includes:
- `cache_key`
- `adapter`
- `metadata` (extensions, syntax highlight settings, plugin list, etc.)

2 changes: 1 addition & 1 deletion docs/user/05-rendering-and-preview-pipeline.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ This guide focuses on preview generation and render diagnostics.
## Components in this guide

- `Jido.Document.Renderer`
- `Jido.Document.Actions.Render` (via `Agent.command/4`)
- `Jido.Document.Actions.Render` (via `Jido.Document.Agent.command/4`)

## 1. Render directly from markdown

Expand Down
5 changes: 2 additions & 3 deletions docs/user/07-history-checkpoints-and-safe-persistence.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,8 +44,8 @@ end

Other recovery utilities:

- `Agent.discard_recovery/1`
- `Agent.list_recovery_candidates/1`
- `Jido.Document.Agent.discard_recovery/1`
- `Jido.Document.Agent.list_recovery_candidates/1`

## 3. Save divergence protection

Expand Down Expand Up @@ -82,4 +82,3 @@ If high-severity findings are unapproved, save is blocked.
## Next

Continue with [08 - Schema Validation and Migration](./08-schema-validation-and-migration.md).

6 changes: 5 additions & 1 deletion mix.exs
Original file line number Diff line number Diff line change
Expand Up @@ -76,9 +76,13 @@ defmodule JidoDocument.MixProject do

defp docs do
[
main: "readme",
main: "Jido.Document",
source_ref: "v#{@version}",
source_url: "https://github.com/pcharbon70/jido_document",
groups_for_extras: [
"User Guides": ~r"docs/user/.*\\.md",
"Developer Guides": ~r"docs/developer/.*\\.md"
],
extras: [
"README.md",
"docs/public-api.md",
Expand Down