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 when to preview and test the docs 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 install the archbee cli the archbee cli is required to preview documentation locally and run validation commands install dependencies node js https //nodejs org/en/downloadnpm https //docs npmjs com/cli/v11/configuring npm/install install archbee cli npm install global @archbee/cli verify installation archbee version if the command prints a version number, the installation completed successfully archbee cli is in beta phase and receives frequent patches (see known issues docid\ sqve0qu9p8dcocrgwryft ), so remember to update it often archbee update run a live reload server after installing the archbee cli, you can start a local preview server that automatically reloads when files change run a live reload server archbee dev this command starts a local development server and opens the preview url in your default browser edit and preview the docs preview server automatically rebuilds and reloads the browser when you edit markdown files and archbee json stop the preview server to stop the preview server, press ctrl+c in the terminal known issues if you see that documentation content is rendered incorrectly, first of all, restart the preview server (cli v0 1 33) complex formatting, such as lists inside table cells, may disappear on preview server if markup syntax is correct, it will render correctly on docs flipper net (cli v0 1 33) if a page's url does not match the file path, links to this page result in 404 on preview server if archbee broken links shows no errors, the links will work correctly on docs flipper net check the documentation structure 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 incorrect file paths (renamed, removed, typos in the path) files in the /docs directory that are missing from archbee json missing or incorrect configuration values archbee validate example output of a successful validation validating documentation project config ok (archbee json) parsing ok space flipper one documentation docs path ok (docs/) navigation ok (49 docs, 9 categories) validation passed this check runs automatically on each pull request and is required to merge it check the documentation links you can check that internal documentation links are valid the check verifies links between documentation pages and links to headings (anchors) archbee broken links example output of a successful check scanned 49 documents for broken links no broken links found (71 internal links checked) this check runs automatically on each pull request and is required to merge it external links in the documentation and all links in the readme md are not checked remember to verify and update them manually