[docs] Copy changelog, fix —help scraping (#30)

Author: irskep

docs/CHANGELOG.md

@@ -0,0 +1,9 @@
+# Changelog
+
+<!-- loosely based on https://keepachangelog.com/en/1.0.0/ -->
+
+## Unreleased
+
+## 0.1.0 - 2025-07-06
+
+- Initial release of persistproc

docs/index.md

@@ -95,14 +95,14 @@ The server exposes the following tools:
 
 | Tool | Description |
 | --- | --- |
-| `start(command: str, working_directory: str, environment: dict = None, label: str = None)` | Start a new long-running process. |
-| `list()` | List all managed processes and their status. |
-| `status(pid: int = None, command_or_label: str = None, working_directory: str = None)` | Get the detailed status of a specific process. |
-| `stop(pid: int = None, command_or_label: str = None, working_directory: str = None, force: bool = False, label: str = None)` | Stop a running process. |
-| `restart(pid: int = None, command_or_label: str = None, working_directory: str = None)` | Stops a process and starts it again with the same parameters. |
-| `output(pid: int = None, command_or_label: str = None, stream: str = "combined", lines: int = None, before_time: str = None, since_time: str = None, working_directory: str = None)` | Retrieve captured output from a process. |
-| `get_log_paths(pid: int = None, command_or_label: str = None, working_directory: str = None)` | Get the paths to the log files for a specific process. |
-| `kill_persistproc()` | Kill all managed processes and get the PID of the persistproc server. |
+| start | Start a new long-running process. |
+| list | List all managed processes and their status. |
+| status | Get the detailed status of a specific process. |
+| stop | Stop a running process. |
+| restart | Stops a process and starts it again with the same parameters. |
+| output | Retrieve captured output from a process. |
+| get_log_paths | Get the paths to the log files for a specific process. |
+| kill_persistproc | Kill all managed processes and get the PID of the persistproc server. |
 
 ## Getting started
 

mkdocs.yml

@@ -8,6 +8,7 @@ nav:
   - Home: index.md
   - tools.md
   - labels.md
+  - Changelog: CHANGELOG.md
 
 theme:
   name: material

persistproc/cli.py

@@ -105,7 +105,8 @@ def parse_command_and_args(program: str, args: list[str]) -> tuple[str, list[str
 def parse_cli(argv: list[str]) -> tuple[CLIAction, CLIMetadata]:
     """Parse command line arguments and return a CLIAction and metadata."""
     parser = argparse.ArgumentParser(
-        description="Process manager for multi-agent development workflows\n\nDocs: https://steveasleep.com/persistproc"
+        prog="persistproc",
+        description="Process manager for multi-agent development workflows\n\nDocs: https://steveasleep.com/persistproc",
     )
 
     # ------------------------------------------------------------------

pp

@@ -15,12 +15,23 @@ SCRIPT_DIR=$( cd -- "$( dirname -- "${BASH_SOURCE[0]}" )" &> /dev/null && pwd )
 # Change to the script's directory to ensure relative paths work correctly for setup
 cd "$SCRIPT_DIR"
 
-# Use mise to sync dependencies if available, otherwise fall back to uv directly
-if command -v mise &> /dev/null; then
-  mise deps:sync
+# Check if this is a help command to suppress mise output
+if [[ " $* " =~ " --help " ]]; then
+  # For help commands, run mise silently
+  if command -v mise &> /dev/null; then
+    mise deps:sync > /dev/null 2>&1
+  else
+    # Fallback: use uv directly, silently
+    uv sync --extra docs --extra dev > /dev/null 2>&1
+  fi
 else
-  # Fallback: use uv directly
-  uv sync --extra docs --extra dev
+  # Use mise to sync dependencies if available, otherwise fall back to uv directly
+  if command -v mise &> /dev/null; then
+    mise deps:sync
+  else
+    # Fallback: use uv directly
+    uv sync --extra docs --extra dev
+  fi
 fi
 
 # Change back to the original directory before running the user's command

pyproject.toml

@@ -5,7 +5,7 @@ build-backend = "hatchling.build"
 [project]
 name = "persistproc"
 version = "0.1.1"
-description = "A shared process layer for the modern, multi-agent development workflow (Unix-only)."
+description = "A shared process layer for the modern, multi-agent development workflow."
 readme = "README.md"
 requires-python = ">=3.10"
 license = { text = "MIT" }
@@ -38,6 +38,7 @@ dev = [
     "pytest>=7.0", 
     "pytest-asyncio>=0.21", 
     "pytest-cov>=4.0",
+    "pytest-timeout>=2.1.0",
     "pytest-xdist",
     "pre-commit>=3.0.0",
     "uvicorn>=0.35.0",

pytest.ini

@@ -6,6 +6,8 @@ python_functions = test_*
 addopts = 
     --verbose
     --tb=short
+    --timeout=120
+    --maxfail=3
 markers =
     unit: Unit tests
     integration: Integration tests

scripts/prepare-docs.sh

@@ -4,6 +4,9 @@ set -e
 # Copy README.md to docs/index.md
 cp README.md docs/index.md
 
+# Copy CHANGELOG.md to docs/
+cp CHANGELOG.md docs/
+
 # Remove the 'full docs:' link line
 sed -i.bak '/> Full docs:/d' docs/index.md
 

scripts/update_docs_help.py

@@ -24,8 +24,19 @@ def get_help_text(command):
     print(" ✅")  # Complete the progress line
 
     output_lines = result.stdout.splitlines()
+
+    # Filter mise and uv dependency installation output
+    dependency_patterns = [
+        r"Installing dependencies\.\.\.",
+        r"^\[deps:sync\]",
+        r"^\s*\+\s+\w+==",  # + package==version
+        r"^\s*\$\s+uv\s+sync",  # $ uv sync commands
+    ]
+
     filtered_output_lines = [
-        line for line in output_lines if "Installing dependencies..." not in line
+        line
+        for line in output_lines
+        if not any(re.search(pattern, line) for pattern in dependency_patterns)
     ]
     output = "\n".join(filtered_output_lines)