Files
ferrix/docs
Rayhaan JaufeerallyandClaude Fable 5.1 277b973f1a Status page: what moved, what is missing, and a dark room
The attention strip's names lead to the peer's row, which lights up for a
moment. The IPv4 and IPv6 sessions of one neighbour (NAME-v4, NAME-v6) are
listed together, joined down the side, the name said once in full. A route
count that moved by more than 2% between refreshes carries ▲ or ▼ for two
minutes; a row whose state or count changed while the tab was in the
background carries ● until it is clicked. A compact mode drops the next
hop and session columns, and is remembered by the browser. Colours are
variables, with a second set for prefers-color-scheme: dark.

A new per-peer `expected_routes` says about how many routes a peer sends
when all is well. The daemon only passes it to the API; the page lists an
established peer with under half of it as needing attention, a minute
after the session came up, with the expected count beside the actual one.
An established session with next to no routes looked, until now, exactly
like one that was fine.

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
2026-10-07 23:16:01 +02:00
..

Documentation sources

This directory holds the sources of the Ferrix documentation site, built with Zola:

zola --root docs serve     # http://127.0.0.1:1111, rebuilt on every change
zola --root docs build     # into docs/public

The pages under content/ are Markdown with Zola additions, which a code forge does not render:

  • The block between +++ lines at the top of each page is its front matter: the title, description and position in the navigation.
  • {{ example(name="...") }} and {{ file(name="...") }} insert a file from examples/, whole, at that point. Open the file to read it.
  • Links of the form @/docs/... are internal links that Zola resolves and checks at build time. On the forge they do not work; the target is the path after @/, under content/.

To read the documentation as intended, build the site, or read it where it is published (base_url in config.toml).

STYLE.md is the writing guide. CI builds the site on every push and fails on a link to a page or an anchor that does not exist; zola --root docs check also checks external links.