Files
Open_Ultra_SAST/mkdocs.yml
T
Marius CiepluchandClaude Fable 5.1 5aac7eac36 docs: audit against v2.0.0; deployment guide (local ax and a separate Kubernetes cluster)
Every README and docs page checked against ousast --help, the code and the committed records. New docs/deployment.md (in the nav): what runs where today, this host's setup (up.sh, doctor, smoke Run, footprint), step-by-step guidance for a separate Kubernetes cluster with implemented vs planned stated per item (no cluster deployment has been made; kube context and doctor's registry check are hard-coded in doctor.py, egress.py, router.py), and what the plane/ manifests need changed. Decision-engine pages state slice 2 (six families, pooled and within-pair AUC, BLOCK offered nowhere, canary below 0.9 for three families, positives-only inflation) and that the engine is not adopted; exp-002 registered, not run, no result quoted. Fixed: model/judge.py reference (now model/pipeline.py), missing-key behaviour, .env reference (OPENROUTER_EMBEDDING_MODEL, store variables), docs extra, plane memory-normalise and ousast index listed, ax README's cluster table made precise. RELEASE_NOTES gets an Unreleased entry.

Co-Authored-By: Claude Fable 5.1 <[email protected]>
Claude-Session: https://claude.ai/code/session_01EmM1j46qgKMh3zqD1QMwEo
2026-10-02 16:03:46 +02:00

69 lines
1.8 KiB
YAML

site_name: OpenUltraSAST
site_description: An experimental static security analyser and repository safety net, with an agentic plane and a learned decision engine in development.
repo_url: https://github.com/norandom/OpenUltraSAST
edit_uri: edit/main/docs/
docs_dir: docs
site_dir: site
strict: true
theme:
name: material
features:
- navigation.sections
- navigation.top
- content.code.copy
- search.highlight
palette:
- media: "(prefers-color-scheme: light)"
scheme: default
toggle:
icon: material/brightness-4
name: Dark mode
- media: "(prefers-color-scheme: dark)"
scheme: slate
toggle:
icon: material/brightness-7
name: Light mode
validation:
omitted_files: warn
absolute_links: warn
unrecognized_links: warn
anchors: warn
markdown_extensions:
- admonition
- attr_list
- tables
- toc:
permalink: true
- pymdownx.details
- pymdownx.snippets:
base_path: ["."]
check_paths: true
- pymdownx.superfences:
custom_fences:
- name: mermaid
class: mermaid
format: !!python/name:pymdownx.superfences.fence_code_format
nav:
- Overview: index.md
- How it works:
- Scanning: scanning.md
- Architecture: architecture.md
- The plane on ax: plane.md
- Memory: memory.md
- Memory and detection: memory-and-detection.md
- Decision engine: decision-engine.md
- Token ergonomics: token-ergonomics.md
- Evaluation: evaluation.md
- Using it:
- Examples: examples.md
- Threat model: threat-model.md
- Operations (maintainers):
- Engine and pre-push: ops/README.md
- ax on this host: ops/ax/README.md
- Deployment: deployment.md
- RustFS setup for the memory store: rustfs.md