|
2 | 2 |
|
3 | 3 | All notable changes to this project will be documented in this file. |
4 | 4 |
|
| 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 | + |
5 | 98 | ## [0.5.0] - 2026-02-12 |
6 | 99 |
|
7 | 100 | ### "Marie Kondo" Release - Code Quality & Release Finalization |
@@ -151,12 +244,12 @@ None at this time. |
151 | 244 |
|
152 | 245 | Available on PyPI: |
153 | 246 | ```bash |
154 | | -pip install venturalitica-sdk==0.5.0 |
| 247 | +pip install venturalitica==0.5.0 |
155 | 248 | ``` |
156 | 249 |
|
157 | 250 | Or with UV: |
158 | 251 | ```bash |
159 | | -uv add venturalitica-sdk==0.5.0 |
| 252 | +uv add venturalitica==0.5.0 |
160 | 253 | ``` |
161 | 254 |
|
162 | 255 | --- |
|
0 commit comments