CoreRasurae
9dc3f7910b
CI / lint (push) Successful in 1m7s
CI / typecheck (push) Successful in 1m8s
CI / security (push) Successful in 1m7s
CI / quality (push) Successful in 41s
CI / integration_tests (push) Successful in 1m13s
CI / build (push) Successful in 1m22s
CI / unit_tests (push) Successful in 3m13s
CI / coverage (push) Successful in 3m9s
CI / status-check (push) Successful in 3s
Created comprehensive MkDocs-formatted API documentation under docs/registry/ covering all public API surfaces from the registry subsystem with real-life constructive examples: - index.md: Architecture overview, module relationships, quickstart - types.md: PackageType, PackageId, PackageReference, PackageContent - client.md: RegistryClient with all 4 endpoints, auth modes, async patterns - canonical.md: Canonicalizer pipeline — NFC, RFC-8785, SHA-1, lifecycle stripping - resolver.md: ReferenceResolver — 3 reference schemes, version alias resolution - exceptions.md: RegistryError hierarchy — all 9 typed exceptions with HTTP mapping - cache.md: RegistryCache — LRU eviction, TTL, SHA-1 tamper detection, singleflight - integration.md: 4 end-to-end workflows (ordering pipeline, email categorization, CI/CD verification, multi-tenant provisioning) Updated mkdocs.yml nav tree with docs/registry/ entries. Refs: #51
98 lines
3.2 KiB
YAML
98 lines
3.2 KiB
YAML
site_name: CleverActors
|
|
site_description: Declarative actor parser, validator, and LangGraph compiler. Enables actor graphs on top of LLMs.
|
|
site_url: https://docs.cleverthis.com/cleveractors
|
|
repo_url: https://git.cleverthis.com/cleverlibre/cleveractors
|
|
repo_name: cleverlibre/cleveractors
|
|
edit_uri: src/branch/master/docs
|
|
|
|
nav:
|
|
- Home: index.md
|
|
- Package Registry:
|
|
- Overview: registry/index.md
|
|
- Types: registry/types.md
|
|
- RegistryClient: registry/client.md
|
|
- Canonicalizer: registry/canonical.md
|
|
- ReferenceResolver: registry/resolver.md
|
|
- Exceptions: registry/exceptions.md
|
|
- RegistryCache: registry/cache.md
|
|
- Integration Examples: registry/integration.md
|
|
- Development:
|
|
- Quality Automation: development/quality-automation.md
|
|
|
|
theme:
|
|
name: material
|
|
features:
|
|
- navigation.tabs
|
|
- navigation.tabs.sticky
|
|
- navigation.top
|
|
- search.suggest
|
|
- search.highlight
|
|
- toc.follow
|
|
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
|
|
|
|
extra_css:
|
|
# KaTeX stylesheet, served locally from docs/stylesheets/katex/.
|
|
# This is the *only* math-rendering asset the browser needs at view
|
|
# time; all equations are pre-rendered at build time by
|
|
# hooks/math_prerender.py using the KaTeX npm package in node_tools/.
|
|
# No MathJax JavaScript is loaded at runtime, which dramatically
|
|
# reduces page weight and time-to-interactive for math-heavy pages
|
|
# such as the IHUFT proposal.
|
|
- stylesheets/katex/katex.min.css
|
|
- stylesheets/extra.css
|
|
|
|
extra_javascript:
|
|
# Tiny (~1 KB) helper that powers the click-to-copy button on each
|
|
# display equation. This is *not* a math renderer — the math itself is
|
|
# static, pre-rendered HTML+MathML. This script only handles the
|
|
# interaction layer: read data-latex from the wrapping .math-display
|
|
# element, write it to the system clipboard, briefly flash a "Copied!"
|
|
# confirmation. Math still renders perfectly with this script absent;
|
|
# only the one-click copy convenience degrades.
|
|
- javascripts/math_copy.js
|
|
|
|
plugins:
|
|
- search
|
|
|
|
# Build-time hooks. Order matters:
|
|
# 1. layperson_filter.py — conditionally strips !!! layperson admonitions
|
|
# depending on the IHUFT_LAYPERSON environment variable.
|
|
# 2. math_prerender.py — pre-renders every $…$ and $$…$$ expression to
|
|
# static KaTeX HTML+MathML using a one-shot Node subprocess. Must run
|
|
# *before* Markdown parsing so the resulting raw HTML survives intact.
|
|
hooks:
|
|
- hooks/layperson_filter.py
|
|
- hooks/math_prerender.py
|
|
|
|
markdown_extensions:
|
|
- admonition
|
|
- pymdownx.details
|
|
- pymdownx.superfences
|
|
- pymdownx.tabbed:
|
|
alternate_style: true
|
|
- pymdownx.tasklist:
|
|
custom_checkbox: true
|
|
# pymdownx.arithmatex is intentionally NOT enabled. The
|
|
# math_prerender.py hook handles all math extraction and replaces it
|
|
# with raw KaTeX HTML before Markdown sees it.
|
|
- attr_list
|
|
- def_list
|
|
- footnotes
|
|
- md_in_html
|
|
- tables
|
|
- toc:
|
|
permalink: true
|
|
toc_depth: 1-6
|