Skip to content
Riot Docs

Search is only available in production builds. Try building and previewing the site to test it out locally.

Install Riot GitHub

riot doc

riot doc turns package interfaces into browsable documentation.

Docs are part of the package lifecycle:

  • they define how strangers will experience the package
  • they should line up with public .mli surfaces
  • they should be generated in a way that respects package versions and dependency links
  • package docs generated from interface files
  • links that follow package relationships
  • local dev output for workspace browsing
  • release-oriented output that can later be published

Read this page whenever docs stop being “nice to have” and start being part of the package contract.