Skip to content

Readsmith 0.1.0

Choose a tag to compare

View all tags
@gnana997 gnana997 released this 11 Jul 19:23
· 75 commits to main since this release
v0.1.0
d77a84a

The first public release of Readsmith, the Fair Source documentation platform.

What's in 0.1.0

  • Precompiled MDX pipeline: deterministic builds, immutable bundles, zero-JS prose pages with islands only where a page asks for them
  • The reading experience: Spectral/IBM Plex type system, first-class light and dark themes, WCAG 2.1 AA
  • Component library: callouts, tabs, steps, cards, accordions, code groups, frames, Mermaid diagrams, and more, usable in plain Markdown or MDX
  • Generated API reference from OpenAPI: one continuous page or one page per operation, with hybrid authored + generated pages
  • Search and Ask AI on your own model keys (OpenAI, Anthropic, Google, or a gateway): hybrid full-text + vector search, streamed cited answers
  • Agent-ready outputs from the first build: llms.txt, per-page Markdown, an MCP server, and generated Agent Skills at /skill.md
  • Self-host with one compose file: the app plus Postgres with pgvector is the entire stack; subpath hosting (yourdomain.com/docs) supported
  • Mintlify-compatible docs.json accepted for migration

License

Fair Source, under the Functional Source License (FSL-1.1-MIT): free to self-host with every feature. Per the license, this release automatically becomes MIT-licensed two years from today.

Docs: https://readsmith.dev/docs

Assets 2
Loading