Shoalrun documentation frameworkMenu
For agents
Start with https://www.shoalrun.com/llms.txt for the documentation index, then read the Markdown pages it links. Skip to article. Documentation index. Read this page as Markdown.
Changelog entry

Shoalrun 1.0 — SDK references and smoother font loading

Generate code API references from source and docstrings, choose how readers browse them, and load custom fonts earlier.

Version 1.0.0
Read as Markdown

Upgrade to CLI 1.0.0 and rebuild to apply these changes. Regenerate a code-reference snapshot whenever its source or docstrings change.

Generate SDK references

Turn Python source and docstrings into native reference pages with declarations, linked types, field defaults, parameters, and examples. Other languages can bring a converter using the same JSON format. Choose separate symbol pages, inline class or module references, and an optional complete reference on one page. Publication and customer-profile selection apply to every layout; HTML, Markdown, content delivery, and PDF workflows retain the selected content.

Load custom fonts earlier

Local custom body and heading fonts get preload hints and versioned asset URLs for caching. Bundled fonts revalidate instead of remaining stale in a development browser.

Stable npm release channel

Shoalrun 1.0 uses npm's latest channel. Publication verifies distribution tags separately from the upload, so interrupted tagging can resume without uploading the same version again. Future prereleases keep a stable latest in place.