docs

command
v0.0.0-...-e4e27b8 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Oct 13, 2026 License: Apache-2.0 Imports: 14 Imported by: 0

Documentation

Overview

Command docs builds the Conductor documentation in docs/slashdocs into self-contained HTML pages, and publishes them to a slashdocs server.

go run ./scripts/docs build                  # writes docs/slashdocs/dist/*.html
go run ./scripts/docs publish                # creates or updates each page in slashdocs
go run ./scripts/docs publish -m "Explain fencing"

Publishing uses the slashdocs CLI (logged in with `slashdocs auth login`). The first publish creates one document per page; later ones push a new version of each page whose HTML changed. Links between pages point at their slashdocs documents. What was published where is kept in docs/slashdocs/published.json (per server; not committed).

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL