Preview and test the docs

This page explains how to preview changes and run checks locally while you work on your contribution to the Flipper One documentation.

Flipper One documentation is built from markdown sources and hosted on Archbee. Changes are published automatically after merging a pull request to the default branch (public-release).

Archbee CLI allows you to preview your changes locally on an almost-exact website copy while you write, update, or review the documentation.

The Archbee CLI is required to preview documentation locally and run validation commands.

If the command prints a version number, the installation completed successfully.

Archbee CLI is in beta phase and receives frequent patches (see known issuesknown issues), so remember to update it often:

After installing the Archbee CLI, you can start a local preview server that automatically reloads when files change.

If you see that documentation content is rendered incorrectly, first of all, restart the preview server.

Documentation structure is defined in the archbee.json configuration file. It changes when you add, move, rename, or delete documentation pages.

Use the archbee validate command to find all kinds of structure errors in archbee.json:

Example output of a successful validation:

You can check that internal documentation links are valid. The check verifies links between documentation pages and links to headings (anchors).

Example output of a successful check: