From e99b7aa7c4278d547d94b49f9ad923aa5fc44186 Mon Sep 17 00:00:00 2001
From: Harpo Harbert <ryan_harbert@wgbh.org>
Date: Mon, 9 Sep 2024 13:58:23 -0700
Subject: [PATCH] Adds maintenance section to docs

---
 docs/{pdm.md => maintenance.md} | 24 ++++++++++++++++++++++--
 mkdocs.yml                      |  3 ++-
 pyproject.toml                  |  1 +
 3 files changed, 25 insertions(+), 3 deletions(-)
 rename docs/{pdm.md => maintenance.md} (64%)

diff --git a/docs/pdm.md b/docs/maintenance.md
similarity index 64%
rename from docs/pdm.md
rename to docs/maintenance.md
index b82b5a5..9c54f7b 100644
--- a/docs/pdm.md
+++ b/docs/maintenance.md
@@ -1,6 +1,6 @@
-# PDM
+# Maintenance
 
-Package management scripts for ov-wag
+This page describes how to maintain the project. This includes [running scripts](#run-scripts), [creating lockfiles](#create-lockfiles), and [updating dependencies](#update-lockfiles).
 
 ## Install project
 
@@ -37,3 +37,23 @@ pdm update --prod -G production -L pdm-locks/pdm.prod.lock --unconstrained --sav
 # docs
 pdm update --no-default -G docs -L pdm-locks/pdm.doc.lock --unconstrained --save-compatible --no-self
 ```
+
+## Run tests
+
+```bash
+pytest
+```
+
+## Serve docs
+
+Use the project script shortcut:
+
+```bash
+ov-docs
+```
+
+Or pass custom arguments to the underlying command:
+
+```bash
+mkdocs serve [args]
+```
diff --git a/mkdocs.yml b/mkdocs.yml
index 1f368d5..ee3884c 100644
--- a/mkdocs.yml
+++ b/mkdocs.yml
@@ -8,6 +8,7 @@ nav:
   - Home: index.md
   - Setup: setup.md
   - Develop: dev.md
+  - Maintenance: maintenance.md
   - Reference: reference
 markdown_extensions:
   - admonition
@@ -19,7 +20,7 @@ markdown_extensions:
   - pymdownx.caret
   - pymdownx.details
   - pymdownx.emoji:
-      emoji_index: !!python/name:material.extensions.emoji.twemoji 
+      emoji_index: !!python/name:material.extensions.emoji.twemoji
       emoji_generator: !!python/name:material.extensions.emoji.to_svg
   - pymdownx.highlight
   - pymdownx.inlinehilite
diff --git a/pyproject.toml b/pyproject.toml
index e3918eb..e2a2596 100644
--- a/pyproject.toml
+++ b/pyproject.toml
@@ -28,6 +28,7 @@ repository = 'https://github.com/WGBH-MLA/ov-wag'
 
 [project.scripts]
 ov = 'cli:app'
+ov-docs = 'mkdocs.commands:serve.serve'
 
 [project.optional-dependencies]
 cli = [