stargraph/mkdocs.yml at main · KrakenNet/stargraph · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
site_name: Stargraph
site_description: Stateful agent-graph framework with deterministic governance
site_url: https://stargraph.krakn.ai
repo_url: https://github.com/KrakenNet/stargraph
repo_name: KrakenNet/stargraph

theme:
  name: material
  palette:
    - scheme: default
      primary: indigo
      accent: indigo
      toggle: { icon: material/brightness-7, name: Switch to dark mode }
    - scheme: slate
      primary: indigo
      accent: indigo
      toggle: { icon: material/brightness-4, name: Switch to light mode }
  features:
    - navigation.tabs
    - navigation.sections
    - navigation.expand
    - navigation.top
    - search.suggest
    - search.highlight
    - content.code.copy

plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          paths: [src]
          options:
            show_source: true
            show_root_heading: true
            members_order: source

extra:
  version: { provider: mike, default: latest, alias: true }

# AGENTS.md files are agent work-contracts (DOX), not site pages. graphify-out/
# is gitignored tooling output that may appear under docs/ locally.
exclude_docs: |
  AGENTS.md
  graphify-out/

nav:
  - Home: index.md
  - Getting Started: getting-started.md
  - Architecture map: architecture-map.md
  - Tutorials:
      - Overview: tutorials/index.md
      - First graph: tutorials/first-graph.md
      - Add a Fathom rule pack: tutorials/fathom-rules.md
      - Agent with retrieval: tutorials/agent-with-retrieval.md
      - HITL graph: tutorials/hitl-graph.md
      - ML node graph: tutorials/ml-node-graph.md
      - Serve and replay: tutorials/serve-and-replay.md
  - How-to Guides:
      - Overview: how-to/index.md
      - Author a graph in simple YAML: how-to/authoring-format.md
      - Write a tool plugin: how-to/write-tool-plugin.md
      - Build a skill: how-to/build-skill.md
      - Write a markdown skill (SKILL.md): how-to/write-markdown-skill.md
      - Build a graph: how-to/build-graph.md
      - Build an agent: how-to/build-agent.md
      - Author a Bosun pack: how-to/bosun-pack.md
      - Persist with checkpointer: how-to/checkpointer.md
      - Add a rule pack: how-to/add-rule-pack.md
      - Add a store provider: how-to/add-store-provider.md
      - Add a trigger: how-to/add-trigger.md
      - Add an MCP server: how-to/add-mcp-server.md
      - Add a Nautilus source: how-to/add-nautilus-source.md
      - Containers (Docker & Helm): guides/containers.md
  - Security:
      - STRIDE threat model: security/threat-model.md
      - Sign-off rubric: security/sign-off.md
  - Concepts:
      - Overview: concepts/index.md
      - IR & schema: concepts/ir.md
      - Plugin model: concepts/plugins.md
      - Provenance & replay: concepts/provenance.md
  - Engine:
      - Overview: engine/index.md
      - Checkpointer Protocol: engine/checkpointer.md
      - Replay: engine/replay.md
      - Counterfactuals: engine/counterfactual.md
  - Serve:
      - Overview: serve/overview.md
      - HTTP API: serve/api.md
      - WebSocket stream: serve/ws.md
      - Triggers: serve/triggers.md
      - Scheduler: serve/scheduler.md
      - Run history: serve/runs.md
      - CLI: serve/cli.md
      - Bosun packs: serve/bosun.md
      - Profiles: serve/profiles.md
      - Nautilus broker: serve/nautilus.md
      - HITL: serve/hitl.md
      - Artifacts: serve/artifacts.md
  - Knowledge:
      - Overview: knowledge/index.md
      - Stores: knowledge/stores.md
      - Skills: knowledge/skills.md
      - Memory: knowledge/memory.md
      - Retrieval: knowledge/retrieval.md
      - Cypher subset: knowledge/cypher-subset.md
      - Air-gap (model staging): knowledge/air-gap.md
      - Reference skills tutorial: knowledge/reference-skills.md
  - Explanation:
      - Versioning policy: explanation/versioning.md
      - Fathom gaps: explanation/fathom-gaps.md
  - Reference:
      - IR JSON Schema: reference/ir-schema.md
      - Plugin manifest: reference/plugin-manifest.md
      - Hookspecs: reference/hookspecs.md
      - CLI: reference/cli.md
      - Tools: reference/tools.md
      - Skills: reference/skills.md
      - RL toolkit: reference/rl.md
      - Release signing: reference/signing.md
      - v1 limits: reference/v1-limits.md
      - Nodes:
          - Overview: reference/nodes/index.md
          - NodeBase: reference/nodes/base.md
          - DSPyNode: reference/nodes/dspy.md
          - Prebuilt nodes: reference/nodes/prebuilt.md
          - MLNode: reference/nodes/ml.md
          - MemoryWriteNode: reference/nodes/memory.md
          - RetrievalNode: reference/nodes/retrieval.md
          - SubGraphNode: reference/nodes/subgraph.md
          - WriteArtifactNode: reference/nodes/write-artifact.md
          - InterruptNode: reference/nodes/interrupt.md
          - BrokerNode: reference/nodes/broker.md
      - Stores:
          - Overview: reference/stores/index.md
          - Vector: reference/stores/vector.md
          - Graph: reference/stores/graph.md
          - Doc: reference/stores/doc.md
          - Memory: reference/stores/memory.md
          - Fact: reference/stores/fact.md
          - Embeddings: reference/stores/embeddings.md
          - Rerankers: reference/stores/rerankers.md
      - Adapters:
          - Overview: reference/adapters/index.md
          - DSPy: reference/adapters/dspy.md
          - MCP: reference/adapters/mcp.md
      - Triggers:
          - Overview: reference/triggers/index.md
          - Manual: reference/triggers/manual.md
          - Cron: reference/triggers/cron.md
          - Webhook: reference/triggers/webhook.md

markdown_extensions:
  - admonition
  - pymdownx.details
  - pymdownx.superfences
  - pymdownx.highlight: { anchor_linenums: true }
  - pymdownx.tabbed: { alternate_style: true }
  - toc: { permalink: true }