Skip to content

szl-holdings/docs-site

docs-site

The unified documentation hub for everything SZL — quickstarts, how-to recipes, and the full technical reference for governed AI.

License Build Doctrine v11 SLSA

Docs · Quickstart · Live demo · SZL Holdings

💡 Why it matters

It is where investors, design partners, and engineers go to understand what SZL does, try it in minutes, and verify the claims for themselves — all in plain language with deep technical docs one click away.

▶️ Live demo

Open the live demo →

demo screenshot

Screenshot: SZL Holdings kanchay mark — replace with a live capture of the running surface.

⚡ Quick start (30 seconds)

git clone https://github.com/szl-holdings/docs-site.git
cd docs-site
make quickstart   # or: see docs.szlholdings.com/quickstart

🔍 How it works

In two sentences: this component is part of SZL's governed-AI mesh — it enforces policy and emits signed, replayable audit receipts so every AI action can be verified after the fact. The full mathematical foundation, formal proofs, and protocol details are documented below and in the technical docs.


📐 Full technical detail, math, and proofs (the proof, not the pitch)

SZL Holdings — Unified Documentation Site

License Doctrine v11 LOCKED DOI CI Security Policy

CII Best Practices

The source for the SZL Holdings documentation portal (target: docs.szlholdings.com). It documents the two SZL products (a11oy command platform + killinchu drones & vessels), the PURIQ doctrine and master formula, the twelve anatomy organs plus the Killinchu bridge, the Doctrine v11/v12 LOCKED contract numbers, the evidence ledger (DOIs, replay hash, Lean artifacts), SDKs, API reference, cookbook, use cases, compliance, and brand.


Why VitePress

The brief allowed VitePress, Docusaurus, or MkDocs Material. We chose VitePress 1.6.x.

Requirement How VitePress satisfies it
Dark + light mode Built in to the default theme — no plugin, instant toggle, respects system preference.
Built-in search Ships with local MiniSearch full-text indexing (no Algolia account, no external service, zero recurring cost).
KaTeX math The PURIQ master formula and every organ sub-formula are LaTeX. We render them with @vscode/markdown-it-katex (a markdown-it plugin) — server-side at build time, so math is in the static HTML, fast and JS-light.
Mermaid diagrams vitepress-plugin-mermaid integrates Mermaid into fenced ```mermaid blocks. Used for anatomy data-flow and DAG diagrams.
Copy-button + syntax highlighting Built in (Shiki). Every code block gets a copy button and accurate highlighting with no configuration.
3D iframes Pages are plain markdown + HTML, so embedding the *.static.hf.space 3D showcases as <iframe> is trivial.
Fast static output, easy hosting Vite-powered build emits a flat static bundle deployable to any static host (S3, the pplx.app preview, GitHub Pages, Cloudflare).
Lightweight A Vue/Vite single-toolchain stack — far smaller dependency surface than Docusaurus (React + Webpack/Docusaurus core) and no Python runtime like MkDocs. Faster cold builds, simpler CI.

Docusaurus was rejected as heavier than needed for a docs-only site (React app shell, versioned-docs machinery we do not use). MkDocs Material was rejected because KaTeX + Mermaid + Vue-style theming is less ergonomic and it adds a Python toolchain alongside the Node tooling the rest of the SZL stack already uses.


Project layout

szl_docs_site/
├── package.json                 # scripts + deps
├── docs/
│   ├── .vitepress/
│   │   ├── config.mjs           # nav, sidebar, search, KaTeX, Mermaid, fonts
│   │   ├── theme/
│   │   │   ├── index.js         # extends DefaultTheme
│   │   │   └── custom.css       # Kanchay brand tokens (navy/cyan/sand/clay/gold/ink)
│   │   └── dist/                # build output (generated — do not edit by hand)
│   ├── public/
│   │   └── img/                 # logo + 3d/ screenshots
│   ├── index.md                 # Home (hero, what is SZL, two products, CTAs)
│   ├── quickstart.md
│   ├── products/                # index + a11oy, killinchu
│   ├── anatomy/                 # index (12 organs + Killinchu bridge) + 3d-showcases
│   ├── doctrine/                # puriq (master formula), v11-v12 (LOCKED numbers)
│   ├── evidence/                # DOIs, replay hash, Lean, thesis, Khipu receipts
│   ├── sdks/                    # index + python + typescript
│   ├── api/                     # index + a11oy + killinchu (OpenAPI placeholders)
│   ├── cookbook/                # index + anatomy-evolved-v1
│   ├── use-cases/               # warhacker, greene-demo, iron-dome-brain, sovereign-gov
│   ├── compliance.md
│   ├── brand.md
│   ├── status.md
│   └── about.md
└── README.md                    # this file

Develop & build

Prerequisites: Node 18+ and npm.

# install dependencies
npm install

# live dev server with hot reload (http://localhost:5173)
npm run docs:dev

# production build → docs/.vitepress/dist/
npm run docs:build

# preview the production build locally (http://localhost:4173)
npm run docs:preview

How to update content

  1. Edit or add a page. Pages are Markdown under docs/. Front-matter at the top of a file controls layout (e.g. layout: home on index.md).
  2. Add it to the sidebar/nav. Edit docs/.vitepress/config.mjs — the nav array is the top bar, the sidebar object maps URL path prefixes to their link groups.
  3. Math: write LaTeX inside $ ... $ (inline) or $$ ... $$ (block). KaTeX renders it at build time.
  4. Diagrams: use a fenced ```mermaid block.
  5. Code: standard fenced code blocks get syntax highlighting and a copy button automatically. Add a language hint (```python, ```ts, ```bash).
  6. Images / screenshots: drop files in docs/public/img/ and reference them as /img/yourfile.png (the public/ prefix is stripped at build).
  7. Brand colors live as CSS custom properties in docs/.vitepress/theme/custom.css (Kanchay tokens). Adjust there to retheme globally.
  8. Run npm run docs:build, eyeball with npm run docs:preview, then deploy.

Editing the LOCKED contract numbers

The Doctrine v11 LOCKED numbers (749 declarations / 14 unique axioms / 163 sorries / 13-axis yuyay_v3 / replay hash bacf54434f1a3bf2d758b27a62d5fd580ca4c8d3b180693573eeebcaea631fc5) are quoted verbatim on doctrine/v11-v12.md, evidence/index.md, and the home page. These are a frozen contract — do not change them to track live corpus growth. The live snapshot (which drifts) is reported separately and labelled as such. If the doctrine is re-locked at a new version, update all three pages together and bump the version label.


Deploy & the relocatable-build design

The build emits a static bundle at docs/.vitepress/dist/. Two settings make that bundle fully relocatable — it renders correctly no matter what path prefix it is served under, including an unpredictable proxy sub-path (the pplx.app preview):

  1. base: './' + mpa: true in config.mjs. MPA (multi-page app) mode disables VitePress's client-side SPA router, so every page is fully static HTML and there is no router that can 404 when the served path does not match a fixed base. The relative base makes every asset reference relative rather than rooted at /.
  2. fix-relative-paths.mjs runs automatically after vitepress build (wired into the docs:build script). VitePress's base: './' emits ./asset references that are only correct for root-level pages; this post-processor rewrites them to the correct ../-depth for each nested page (e.g. flagships/a11oy.html gets ../assets/...). The result is a bundle every page of which resolves its own assets relative to its own location.

This was a deliberate trade: MPA loses VitePress's instant in-page SPA navigation (each nav click is a real page load), which is an acceptable cost for a documentation site that must survive being served behind an opaque proxy.

  • Current preview host: the Perplexity deploy_website flow uploads docs/.vitepress/dist/ and serves it at a pplx.app proxy URL.
  • Production target: docs.szlholdings.com at the domain root. Because the build is relocatable, it works at root as-is. If you prefer the lighter SPA experience at the production root, you may set base: '/', mpa: false, cleanUrls: true, remove the fix-relative-paths.mjs step, and rebuild — the SPA build is correct when served from a known root.

Source repository

github.com/szl-holdings/docs-site


Maintained by SZL Holdings. Content is the SZL doctrine of record; the LOCKED numbers are a contract. NO BANDAID. Math-grounded, Quechua-rooted.

— Yachay

SZL Holdings

SZL Holdings

The SZL Holdings animated mark (400×400, 16fps loop). Signed Yachay.


Citation & doctrine

Cite this work via CITATION.cff. Math foundations: szl-papers · lutar-lean (kernel c7c0ba17).

Λ Conjecture 1 (not a theorem) · 749/14/163 v11 LOCKED (kernel c7c0ba17) · SLSA Build L1 honest (cosign keyless-signed, Rekor-anchored images) · L2 verified-provenance on the roadmap; L3 / FedRAMP / Iron Bank / CMMC not claimed · locked-proven formulas = 8 {F1,F4,F7,F11,F12,F18,F19,F22} (locked_count_eight) · Section 889 = 5 vendors · SZL Holdings · Apache-2.0 code · CC-BY-4.0 papers

About

SZL Holdings unified documentation — math-grounded, Quechua-rooted governed-AI docs (VitePress). Doctrine v11 LOCKED (749/14/163). docs.szlholdings.com

Topics

Resources

License

Code of conduct

Contributing

Security policy

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors