Skip to content

Commit ef4e699

Browse files
committed
feat: SDK v0.5.2 — dashboard overhaul, lazy graph import, metrics reorganization
- Dashboard: 4-phase mission-driven UI (Identity → Policy → Verify → Report) - Fix: lazy-load graph workflow in annex_generator to avoid crash without agentic extras - Reorganize metrics under assurance/ (fairness, privacy, quality, performance, causal) - Remove legacy venturalitica.graph, venturalitica.fairness, venturalitica.quality paths - Add column-binding docs, compliance-mapping, dashboard guide - E2E test updated for new dashboard title - Probes refactored into individual modules
1 parent 9ebd4bb commit ef4e699

File tree

178 files changed

+8227
-6694
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

178 files changed

+8227
-6694
lines changed

.gitignore

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -57,3 +57,5 @@ results.json
5757
venturalitica_technical_doc.json
5858
system_description.yaml
5959
bom.json
60+
node_modules/
61+
starlight/.astro/

CHANGELOG.md

Lines changed: 95 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,99 @@
22

33
All notable changes to this project will be documented in this file.
44

5+
## [0.5.0-starlight] - 2026-02-18
6+
7+
### Astro Starlight Documentation Migration
8+
9+
Migrated all documentation from MkDocs → Mintlify → **Astro Starlight** (open-source) with bilingual support (EN/ES) and automatic `llms.txt` generation via the `starlight-llms-txt` plugin.
10+
11+
#### New Documentation Platform (`starlight/`)
12+
- **Astro Starlight**: Open-source documentation framework with first-class i18n, search, and static site generation
13+
- **`astro.config.mjs`**: Full configuration with i18n (root EN, `es` locale), 5-group sidebar, `starlight-llms-txt` plugin
14+
- **18 English `.mdx` pages**: Complete content in `src/content/docs/`
15+
- **18 Spanish `.mdx` pages**: Complete Spanish mirror in `src/content/docs/es/` with accent fixes and translated prose
16+
- **`src/content/i18n/es.json`**: Spanish UI string overrides for sidebar groups and labels
17+
- **`src/styles/custom.css`**: Custom theme styling
18+
- **`public/images/`**: Consolidated image assets (logo.svg, favicon.svg, 5 PNGs)
19+
- **Pagefind search**: Indexed 36 pages across 2 languages, 4781 words
20+
21+
#### Syntax Conversions Applied (Mintlify → Starlight)
22+
- Admonitions: `<Note>``:::note`, `<Warning>``:::caution`, `<Tip>``:::tip`, `<Danger>``:::danger`
23+
- Tabbed content: `<Tabs><Tab>` → separate labeled code blocks (no imports needed)
24+
- Card groups: `<CardGroup><Card>` → plain markdown link lists
25+
- Frontmatter: `sidebarTitle``sidebar: { label: "..." }`
26+
- Internal links: removed `/es/` prefix (Starlight handles i18n routing), added trailing slashes
27+
- Spanish accent fixes applied throughout all prose text
28+
29+
#### `llms.txt` Generation
30+
- **`starlight-llms-txt`** plugin auto-generates during build:
31+
- `dist/llms.txt` (586B) — index with links to full/small versions
32+
- `dist/llms-full.txt` (149KB) — complete documentation for LLM consumption
33+
- `dist/llms-small.txt` (128KB) — abridged version with non-essential content removed
34+
35+
#### Key Benefits
36+
- **Open-source**: No vendor lock-in or subscription costs (Mintlify requires paid plan)
37+
- **Native `llms.txt`**: Auto-generated by `starlight-llms-txt` plugin during build
38+
- **i18n**: Root locale (EN) + `es` locale with automatic language routing
39+
- **Search**: Pagefind-powered full-text search across both languages
40+
- **Zero-error build**: 37 pages built in ~10s with zero warnings
41+
42+
#### Cleanup
43+
- Removed `mintlify/` directory (superseded by `starlight/`)
44+
- Removed `mkdocs.yml` configuration file
45+
- Removed MkDocs dependencies from `pyproject.toml` (`mkdocs`, `mkdocs-material`, `mkdocs-macros-plugin`, `mkdocs-static-i18n`, `pymdown-extensions`, `mkdocs-llmstxt`)
46+
- Updated Documentation URL in `pyproject.toml` to `https://venturalitica.github.io/venturalitica-sdk`
47+
- MkDocs `docs/` source directory preserved for reference
48+
49+
---
50+
51+
## [0.5.0-docs] - 2026-02-18
52+
53+
### Documentation Overhaul
54+
55+
Comprehensive documentation rewrite addressing all gaps identified in the strategic audit.
56+
57+
#### New Documentation (8 pages)
58+
- **docs/metrics.md**: Complete metrics reference (35+ metrics, 7 categories, formulas, thresholds)
59+
- **docs/dashboard.md**: Glass Box Dashboard user guide (4 phases, 7 views, session management)
60+
- **docs/policy-authoring.md**: OSCAL policy authoring guide (assessment-plan format, props reference, two-policy pattern)
61+
- **docs/column-binding.md**: Column binding documentation (synonym table, resolution algorithm, multilingual support)
62+
- **docs/experimental.md**: Experimental features page (CLI login/pull/push, SaaS status, feature matrix)
63+
- **docs/probes.md**: Probes reference (7 probes, EU AI Act article mapping, evidence structure)
64+
- **docs/full-lifecycle.md**: Zero to Annex IV single-page walkthrough (copy-paste ready)
65+
- **docs/multiclass-fairness.md**: Multiclass fairness metrics deep dive (7 metrics, strategies, intersectional analysis)
66+
- **docs/compliance-mapping.md**: ISO 42001 / EU AI Act mapping (article-by-article SDK capability mapping)
67+
68+
#### Fixed Documentation (4 pages)
69+
- **docs/api.md**: Fully rewritten with correct `enforce()` and `monitor()` signatures from source code
70+
- **docs/quickstart.md**: Fixed install command from `pip install git+...` to `pip install venturalitica`
71+
- **docs/index.md**: Rewritten with correct install, new doc links, removed stale references
72+
- **docs/es/quickstart.md**: Fixed install command in Spanish mirror
73+
74+
#### Updated Documentation (4 pages)
75+
- **docs/academy/level1_policy.md**: Expanded with real data_policy.oscal.yaml (3 controls), expected output, prop reference table
76+
- **docs/academy/level2_integrator.md**: Fixed commands, added cross-references to new docs
77+
- **docs/academy/level3_auditor.md**: Fixed duplicate heading, updated code to use `load_sample()`, added references
78+
- **docs/academy/level4_annex_iv.md**: Fixed commands, updated code, replaced stale links with new doc references
79+
80+
#### Spanish Mirror (`docs/es/`) — Full Update
81+
- Rewrote `es/api.md` and `es/index.md` to match new English sources
82+
- Rewrote all 4 academy levels (`es/academy/level1–level4`) with updated code, outputs, and cross-references
83+
- Created 8 new Spanish pages: `es/metrics.md`, `es/dashboard.md`, `es/policy-authoring.md`, `es/column-binding.md`, `es/experimental.md`, `es/probes.md`, `es/full-lifecycle.md`, `es/multiclass-fairness.md`, `es/compliance-mapping.md`
84+
- Updated `es/quickstart.md` "What's next" links to point to all new documentation pages
85+
- Verified `es/academy/index.md` and `es/tutorials/01_writing_policy.md` (no changes needed)
86+
87+
#### Housekeeping
88+
- Deleted 15 empty `gov_*.md` placeholder files from project root
89+
- Updated `mkdocs.yml` navigation to include all new documentation pages
90+
- Removed references to nonexistent pages (training.md, integrations.md, compliance-dashboard.md, compliance-gap.md)
91+
- Unified OSCAL format references to `assessment-plan` as canonical throughout docs
92+
- Moved 8 stale English docs and 7 stale Spanish docs to `docs/.archive/` and `docs/es/.archive/` respectively
93+
- Removed `mkdocs-llmstxt` plugin: incompatible with `mkdocs-static-i18n` (i18n sub-build resets plugin state, producing empty `llms.txt`); build now runs with zero warnings
94+
95+
#### Known Issues / Technical Debt
96+
- **Platform migration tracked:** `mkdocs-llmstxt` 0.5.0 is unmaintained and broken with the i18n plugin. Agent-friendly docs (`llms.txt`, content negotiation, per-page `.md` serving) require migrating to a platform with native support — **Mintlify** (recommended for AI compliance SDK) or **Docusaurus** (open-source, community `docusaurus-plugin-llms` plugin). Migration is a separate workstream.
97+
598
## [0.5.0] - 2026-02-12
699

7100
### "Marie Kondo" Release - Code Quality & Release Finalization
@@ -151,12 +244,12 @@ None at this time.
151244

152245
Available on PyPI:
153246
```bash
154-
pip install venturalitica-sdk==0.5.0
247+
pip install venturalitica==0.5.0
155248
```
156249

157250
Or with UV:
158251
```bash
159-
uv add venturalitica-sdk==0.5.0
252+
uv add venturalitica==0.5.0
160253
```
161254

162255
---

README.md

Lines changed: 29 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,17 @@
11
# Venturalítica SDK
22

3-
![coverage](https://img.shields.io/badge/coverage-100%25-brightgreen)
3+
![coverage](https://img.shields.io/badge/coverage-73%25-yellow)
4+
[![PyPI](https://img.shields.io/pypi/v/venturalitica)](https://pypi.org/project/venturalitica/)
5+
[![Python](https://img.shields.io/pypi/pyversions/venturalitica)](https://pypi.org/project/venturalitica/)
6+
[![License](https://img.shields.io/badge/license-Apache%202.0-blue)](LICENSE)
7+
[![Discord](https://img.shields.io/discord/P4RURqRm?label=Discord&logo=discord)](https://discord.gg/P4RURqRm)
48

59
**Frictionless Governance for AI Systems.**
610

711
The Venturalítica SDK enables Data Scientists and ML Engineers to integrate compliance and risk management directly into their training workflows. Built on the **OSCAL** (Open Security Controls Assessment Language) standard, it provides semantic policy enforcement with educational audit trails.
812

13+
**[Join our Discord community](https://discord.gg/P4RURqRm)** — Get help, share your use case, and discuss EU AI Act compliance with other engineers.
14+
915
## ✨ Key Features
1016

1117
- **Glass Box Governance**: Sequential regulatory mapping (Art 9-15) for total transparency.
@@ -21,7 +27,7 @@ The Venturalítica SDK enables Data Scientists and ML Engineers to integrate com
2127
## 📦 Installation
2228

2329
```bash
24-
pip install git+https://github.com/Venturalitica/venturalitica-sdk.git
30+
pip install venturalitica
2531
```
2632

2733
## ⚙️ Configuration
@@ -103,11 +109,11 @@ vl.enforce(
103109

104110
## 📚 Documentation
105111

106-
- **[Tutorial: Zero-Setup Audit](docs/tutorials/local-audit.md)**: "Hello World" - Scan & Visualize in 2 minutes
107-
- **[Tutorial: Training Integration](docs/training.md)**: Add compliance checks to your Python code
108-
- **[Concept: Strict Mode](docs/strict_mode.md)**: Enforcing compliance in CI/CD chains
109-
- **[Concept: The Regulatory Map](docs/compliance-dashboard.md)**: Understanding the Dashboard (Art 9-15)
110-
- **[Concept: Evidence Collection](docs/evidence-collection.md)**: How to record your audits
112+
- **[Quickstart Guide](docs/quickstart.md)**: Get started in 60 seconds
113+
- **[Full Lifecycle Walkthrough](docs/full-lifecycle.md)**: Zero to Annex IV in one page
114+
- **[Policy Authoring](docs/policy-authoring.md)**: Write OSCAL policies for your AI systems
115+
- **[Compliance Dashboard](docs/dashboard.md)**: Understanding the Glass Box Dashboard (Art 9-15)
116+
- **[Evidence Probes](docs/probes.md)**: Automated evidence collection for audits
111117
- **[Samples Repository](https://github.com/venturalitica/venturalitica-sdk-samples)**: Real-world examples
112118

113119
## 🎯 Core Concepts
@@ -153,7 +159,7 @@ Launch the **Local Regulatory Map** to interpret your evidence:
153159
venturalitica ui
154160
```
155161

156-
**[Read the Guide: Understanding the Dashboard](docs/compliance-dashboard.md)**
162+
**[Read the Guide: Understanding the Dashboard](docs/dashboard.md)**
157163

158164
**Features:**
159165
* **Article 9-15 Walk**: A sequential check of Risk, Data, Transparency, and Oversight.
@@ -166,6 +172,21 @@ venturalitica ui
166172
* OSCAL policies
167173

168174

175+
176+
## 📡 Telemetry & Privacy
177+
178+
Venturalítica collects **anonymous usage data** to help us improve the SDK.
179+
- **What we track**: Command usage (`login`, `pull`, `push`), SDK execution times, and errors.
180+
- **What we DO NOT track**: Your datasets, PII, IP addresses, or any code content.
181+
- **Privacy First**: We host our analytics in the **EU** and strictly disable IP tracking (`disable_geoip=True`).
182+
183+
**Opt-Out:**
184+
To disable telemetry completely, set the environment variable:
185+
```bash
186+
export VENTURALITICA_NO_ANALYTICS=1
187+
```
188+
Or follow the standard [DO_NOT_TRACK](https://consoledonottrack.com/) specification.
189+
169190
## 🔒 Data Sovereignty & Privacy
170191

171192
Venturalítica follows a strict **Local-First** architecture.

RELEASE_NOTES.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -182,12 +182,12 @@ This release was completed as part of Phase 4 "Marie Kondo" code quality refacto
182182

183183
Available on PyPI:
184184
```bash
185-
pip install venturalitica-sdk==0.5.0
185+
pip install venturalitica==0.5.0
186186
```
187187

188188
Or with UV:
189189
```bash
190-
uv add venturalitica-sdk==0.5.0
190+
uv add venturalitica==0.5.0
191191
```
192192

193193
---

docs/.archive/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Venturalítica SDK Documentation
22

3-
**Frictionless Governance for AI Systems**
3+
**Frictionless Assurance for AI Systems**
44

55
Welcome! This documentation is designed to get you from zero to compliant in minutes, not days.
66

@@ -78,7 +78,7 @@ Start here if you need **audit-ready documentation**:
7878
4. **Handshake Moment**: Realize you need organizational policies → Upgrade to SaaS
7979

8080
### Path 2: Compliance-First Onboarding
81-
**Goal**: Understand governance architecture before implementation
81+
**Goal**: Understand assurance architecture before implementation
8282

8383
1. [Core Concepts](core-concepts.md) - Understand the "why"
8484
2. [OSCAL Authoring](oscal-authoring.md) - Write your policies

docs/.archive/advanced.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,11 +30,11 @@ By default, the SDK looks for policies in the local filesystem. You can customiz
3030

3131
```python
3232
from venturalitica.storage import LocalFileSystemStorage
33-
from venturalitica.core import GovernanceValidator
33+
from venturalitica.core import AssuranceValidator
3434

3535
# Use custom policy storage location
3636
storage = LocalFileSystemStorage(base_path="/custom/policies")
37-
validator = GovernanceValidator("risks.oscal.yaml", storage=storage)
37+
validator = AssuranceValidator("risks.oscal.yaml", storage=storage)
3838
```
3939

4040
## Robust Evaluation: Handling Missing Columns
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ venturalitica ui
3030
The system will analyze your local `.venturalitica/` folder and pull:
3131
* **System Architecture** (from `bom.json`)
3232
* **Risk Management Status** (from Article 9 Audit Results)
33-
* **Data Governance** (from Article 10 Audit Results)
33+
* **Data Assurance** (from Article 10 Audit Results)
3434
* **Cybersecurity** (from CVE scans)
3535

3636
### Step 3: Download the Draft
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,4 +9,4 @@
99
| **2(e) Human Oversight** | Measures for Article 14, output interpretation tools. | `HandshakeProbe` mandates `vl.enforce()`. Dashboard provides "Glass Box" interpretability. | ✅ High |
1010
| **2(f) Change Management** | Pre-determined changes, continuous compliance technical solutions. | `IntegrityProbe` detects drift. `CI` Strict Mode prevents unapproved changes from deploying. | ✅ High |
1111
| **2(g) Validation & Testing** | Testing data, metrics (accuracy/robustness/bias), test logs. | `vl.monitor()` captures execution metrics. `ComplianceResult` binds metrics to policy objectives. | ✅ High |
12-
| **2(h) Cybersecurity** | Cybersecurity measures put in place. | **HMAC-SHA256 Signing** of evidence + `IntegrityProbe` (Environment Fingerprinting). | ✅ High (Pilot) |
12+
| **2(h) Cybersecurity** | Cybersecurity measures put in place. | **HMAC-SHA256 Signing** of bundles + `IntegrityProbe` (Environment Fingerprinting). | ✅ High (Pilot) |

docs/.archive/cli-tools.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# CLI Tools
22

3-
The Venturalítica SDK provides powerful command-line tools for project analysis, compliance scanning, and interactive governance management.
3+
The Venturalítica SDK provides powerful command-line tools for project analysis, compliance scanning, and interactive assurance management.
44

55
## 1. BOM Scanner: `venturalitica scan`
66

@@ -58,9 +58,9 @@ Validate technical aspects independently of organizational policy.
5858
- **BOM Viewer**: Explore your system's inventory.
5959
- **Green AI Tracking**: View carbon emissions, energy consumption, and training duration.
6060

61-
#### Tab 2: 🏛️ Governance & Risks
62-
Highlight governance gaps and map technical metrics to regulatory requirements.
63-
- **Risk Identification**: List compliance risks (Bias, Oversight, Data Governance).
61+
#### Tab 2: 🏛️ Assurance & Risks
62+
Highlight assurance gaps and map technical metrics to regulatory requirements.
63+
- **Risk Identification**: List compliance risks (Bias, Oversight, Data Assurance).
6464
- **Mitigation Gap Analysis**: Identify missing mitigation plans in your OSCAL policies.
6565

6666
#### Tab 3: 📄 Documentation
Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# The Compliance Dashboard: A Glass Box for AI
22

3-
The **Venturalítica Compliance Dashboard** is your local control center for AI Governance. Unlike "Black Box" compliance tools that operate behind closed doors, Venturalítica provides is a **Glass Box** experience: it exposes the exact technical evidence your system is producing and maps it directly to regulatory obligations.
3+
The **Venturalítica Compliance Dashboard** is your local control center for AI Assurance. Unlike "Black Box" compliance tools that operate behind closed doors, Venturalítica provides is a **Glass Box** experience: it exposes the exact technical evidence your system is producing and maps it directly to regulatory obligations.
44

55
The dashboard makes the abstract concrete. It takes the invisible artifacts of your ML pipeline—metrics, logs, dependencies—and renders them into a **Regulatory Traceability Matrix**.
66

@@ -19,7 +19,7 @@ The core feature of the dashboard is the strict sequential mapping of the **EU A
1919
* `Mitigation Verified`: Your fairness tests passed.
2020
* `Risk Materialized`: A test failed (e.g., Disparate Impact detected).
2121

22-
#### 2. [Article 10: Data Governance](https://artificialintelligenceact.eu/article/10/)
22+
#### 2. [Article 10: Data Assurance](https://artificialintelligenceact.eu/article/10/)
2323
* **The Law**: Training, validation, and testing data must be relevant, representative, and error-free.
2424
* **The Code**: Maps to your **Data Quality Checks** (e.g., class imbalance, missing values) and usage of data libraries (`pandas`, `numpy`).
2525
* **Status**: Flags if data validation was skipped or failed.

0 commit comments

Comments
 (0)