raven
forked from raven-ml/raven
Star 0
Fork 0
Watch
raven www
3 folders · 4 files
generate
site
templates
.gitignore
dune
dune-project
README.md
README.md

Raven Website #

Static site for raven-ml.dev. Built with a small OCaml script (generate/generate.ml) that converts Markdown to HTML using cmarkit.

Build and serve #

dune build www/build
uv run python -m http.server -d _build/default/www/build

Structure #

  • site/ — HTML landing pages and static assets
  • ../doc/ — general documentation (installation, roadmap, etc.)
  • templates/ — HTML templates (main.html, layout_docs.html, layout_docs_lib.html)
  • generate/ — site generator

The build requests odoc output for each registered package, wraps its public modules in the site layout, and adds an API tab to each package. Install the odoc development tool before building (dune tools install odoc when using Dune package management). Missing package documentation fails the build.

Library-specific docs live in each library's doc/ directory (e.g., packages/nx/doc/, packages/rune/doc/) where they're tested with mdx. The site generator pulls them in automatically.

Write link destinations as paths to the file you mean, relative to the file you are editing:

See [Training](03-training.md) for losses and metrics.
See [Nx](../packages/nx/doc/index.md) for arrays.
See the [BERT pipeline](../10-bert-pipeline/) example.

Those resolve in an editor and on a repository host. generate/links.ml turns them into site URLs (/docs/kaun/training/, /docs/nx/, /docs/brot/examples/bert-pipeline/) when the page is rendered, so the same link works in both places. A link to a directory means the page that directory publishes through its README.md or index.md.

Site-absolute destinations (/docs/...) and destinations with no file behind them fail the build, naming the file and line. Images and data files work the same way: reference them by relative path and the generator publishes them alongside the page.

Links to a public .mli work the same way:

Read [Nx](../lib/nx.mli), then [Nx_io](../lib/io/nx_io.mli).

The API module list comes from odoc's package index. Private interfaces are not published.