From 619223cf5eec1595c666ad4c38b62e1e232d4e71 Mon Sep 17 00:00:00 2001 From: Rafael Bradley Date: Sun, 10 Aug 2025 22:52:20 -0300 Subject: [PATCH] Add documentation for documentation server --- README.md | 2 +- src/main.rs | 9 +++++++++ 2 files changed, 10 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index f5e8469..c4e03b6 100644 --- a/README.md +++ b/README.md @@ -5,5 +5,5 @@ To read the documentation, run ```shell $ git clone --branch rewrite https://git.nyeki.dev/payphone/payphone.git $ cd payphone -$ cargo doc --open --no-deps +$ cargo run -- docs ``` diff --git a/src/main.rs b/src/main.rs index e58e061..951ee46 100644 --- a/src/main.rs +++ b/src/main.rs @@ -74,6 +74,15 @@ //! consistency and readability. //! //! More documentation about each group can be found in the respective submodule's documentation. +//! +//! # Documentation Server +//! +//! Payphone has a built-in documentation server that serves the project's documentation and refreshes +//! it on changes. To start the documentation server, run the following command: +//! +//! ```shell +//! $ cargo run -- docs +//! ``` use std::{net::SocketAddr, path::Path, process::Command, sync::mpsc};