 CoreRasurae
|
a7ec0be3ba
|
docs(registry): add MkDocs API documentation and usage examples for Package Registry Client
CI / lint (pull_request) Successful in 48s
CI / typecheck (pull_request) Successful in 59s
CI / security (pull_request) Successful in 57s
CI / quality (pull_request) Successful in 33s
CI / build (pull_request) Successful in 1m0s
CI / integration_tests (pull_request) Successful in 1m32s
CI / unit_tests (pull_request) Successful in 3m36s
CI / coverage (pull_request) Successful in 3m7s
CI / status-check (pull_request) 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
|
2026-06-12 22:34:42 +00:00 |
|