Public API Documentation Coverage

This page maps each public resuxjs package entry point to the documentation that owns its public contract. Source code, package exports, and tests remain the source of truth.

Public package	Primary documentation	Coverage responsibility
resuxjs	Public API Index, Composables and Globals	Application-facing runtime surface
resuxjs/runtime	Runtime Internals, Rendering Lifecycle	Renderer, SSR, templates, composables, payload/client runtime
resuxjs/runtime/core	Runtime Internals	Browser enhancement triggers and scheduling
resuxjs/runtime/router	Runtime Internals, Routing	Lightweight local/external client navigation helpers
resuxjs/runtime/reactivity	Runtime Internals, Reactivity API	Runtime-focused re-export of standalone Resux reactivity
resuxjs/runtime/resume	Runtime Internals, Resumability Deep Dive	Lazy resumable-handler loading and registry contracts
resuxjs/runtime/streaming	Runtime Internals, Rendering Lifecycle	Streaming eligibility and HTML stream helpers
resuxjs/reactivity	Reactivity API, State and Reactivity	Refs, proxies, computed, watch/effect, scheduler and types
resuxjs/compiler	Compiler API, Template Syntax	Compiler entry points, build/result types and SFC limits
resuxjs/build	Package Exports, Compiler API	Public build-contract version, logical module identifiers and artifact paths
resuxjs/create	Project Creation API, CLI	Programmatic scaffolding, arguments and destructive-target safety
resuxjs/i18n	i18n API, i18n and Localization	Module config/types and public translation/path/head helpers
resuxjs/ui	Component catalog, UI Package API	23 components + aliases + module/motion APIs
resuxjs/icons	Icons, Usage, Configuration, Runtime Loading	Registry, SVG component, remote/lazy loading and module config
resuxjs/fonts	Fonts, Configuration, Performance	Google Fonts loader/helper and loading strategies
resuxjs/kit	Resux Kit API, Modules and Route Rules	Module registration/extension helpers and public input types
resuxjs/core	Core API, Lifecycle Hooks	Config resolver, hooks, module container and core app factory
resuxjs/halal	Halal Core API, Halal Core	Policy, scanner/evaluator, enforcement, runtime guard/review utilities
resuxjs/node	Node Handler API, Deployment	Production Node request-handler boundary and options
resuxjs/globals	TypeScript and Generated Types	Generated app-global declarations
resuxjs/package.json	Package Exports	Package metadata export

Focused coverage completed in this overhaul

UI

Every public Rx* component and its matching Resux* alias now has a dedicated page. Pages document verified props, events, slots, styling hooks, native/custom accessibility behavior, and the Vue island/runtime cost. Names are not used to imply behavior the source does not implement—for example, RxReveal is mount-triggered and RxAutoAnimate currently performs one mount animation rather than mutation-aware layout animation.

Media

The renderer-owned ResuxImg, ResuxPicture, ResuxVideo, useResuxImage(), responsive candidate generation, placeholders, preloads, providers/transforms, caching, Sharp/FFmpeg deployment constraints, security, accessibility and progressive-enhancement behavior now live in dedicated media pages.

Fonts

The docs constrain resuxjs/fonts to its verified Google Fonts stylesheet-loader implementation, including strategy precedence, URL grouping, CSP/privacy/performance trade-offs, and unsupported local/provider features.

Icons

The docs distinguish local registry SVG data from client-side remote fetching, correct module defaults, distinguish module metadata from component props, and separate resuxjs/icons from the UI package's placeholder RxIcon.

Low-level and optional public packages

Focused references now cover:

• resuxjs/runtime/core, resuxjs/runtime/router, resuxjs/runtime/reactivity, resuxjs/runtime/resume, and resuxjs/runtime/streaming: focused low-level runtime entry points mapped to the Runtime reference;
• resuxjs/build: the public build-contract identifiers and artifact mapping used by tooling/adapters;
• resuxjs/reactivity: every exported function and public type family;
• resuxjs/compiler: public entry points, result records and environment/compile limits;
• resuxjs/kit: every exported module helper and its input contract;
• resuxjs/core: config constants/resolution, hooks, module contributions and createResux();
• lifecycle hook names with their exact public payload types and dispatch behavior;
• resuxjs/create: programmatic creator and safe destructive-target validation;
• resuxjs/node: production Node handler signature/options and guard/build requirements;
• resuxjs/i18n: verified entry-point types/composables/head helper without claiming internal shared helpers are exported;
• resuxjs/halal: programmatic policy, scanner/evaluator, enforcement, runtime guard, serialization/review and AI/integrity surfaces.

Coverage maintenance rule

When a new public package export or symbol is added:

1. verify it in source/package exports;
2. document it directly or in a clearly appropriate parent reference;
3. document environment, server/client and resumability implications where material;
4. add conceptual/reference cross-links;
5. update this map when a package entry point or ownership area changes.

Docs CI now checks the current resux package.json export map against both this coverage map and Package Exports. Adding a new public package subpath without documenting it fails the parity check.

That CI check is intentionally package-level. Exact public symbol signatures, defaults, implementation semantics, and newly exported symbols inside an existing subpath still require source-aware tests and review. A future richer export-manifest check can extend machine enforcement to that symbol-level contract.