docs: Add mdBook documentation framework

- Set up mdBook for comprehensive project documentation
- Configure GitHub Actions for automatic deployment to GitHub Pages
- Create initial documentation structure with user guides, references, and advanced topics
- Add installation, quick start, and configuration guides
- Document JavaScript rules, shell scripts, and platform-specific features
- Include CLI reference and development documentation
- Configure Rust theme with dark mode support and GitHub integration

The documentation will be available at https://coder.github.io/httpjail/ once deployed.

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <noreply@anthropic.com>

Author: ammario

.github/workflows/docs.yml

@@ -0,0 +1,59 @@
+name: Deploy Documentation
+
+on:
+  push:
+    branches:
+      - main
+      - docs  # Also deploy from docs branch for testing
+    paths:
+      - 'docs/**'
+      - 'book.toml'
+      - '.github/workflows/docs.yml'
+  pull_request:
+    paths:
+      - 'docs/**'
+      - 'book.toml'
+      - '.github/workflows/docs.yml'
+  workflow_dispatch:
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        
+      - name: Setup mdBook
+        uses: peaceiris/actions-mdbook@v2
+        with:
+          mdbook-version: 'latest'
+          
+      - name: Build documentation
+        run: mdbook build
+        
+      - name: Upload artifact
+        if: github.event_name != 'pull_request'
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: ./book
+
+  deploy:
+    if: github.event_name != 'pull_request'
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    needs: build
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

.gitignore

@@ -1,5 +1 @@
-target/
-
-# Local Claude Code instructions (not committed to repo)
-CLAUDE.local.md
-artifacts/
+book

DOCS_README.md

@@ -0,0 +1,56 @@
+# httpjail Documentation
+
+This directory contains the mdBook-based documentation for httpjail.
+
+## Setup
+
+mdBook is already installed. If you need to reinstall:
+
+```bash
+cargo install mdbook
+```
+
+## Development
+
+To work on the documentation locally:
+
+```bash
+# Serve with auto-reload (default port 3000)
+mdbook serve
+
+# Or specify a custom port
+mdbook serve --port 8080
+
+# Build static files
+mdbook build
+```
+
+The documentation will be available at `http://localhost:3000`.
+
+## Structure
+
+- `docs/` - Source markdown files
+- `book/` - Built static HTML (git-ignored)
+- `book.toml` - mdBook configuration
+- `.github/workflows/docs.yml` - GitHub Actions for automatic deployment
+
+## Adding Content
+
+1. Add your markdown file to the appropriate directory in `docs/`
+2. Update `docs/SUMMARY.md` to include your new page
+3. Test locally with `mdbook serve`
+4. Commit and push - GitHub Actions will deploy automatically
+
+## Deployment
+
+Documentation is automatically deployed to GitHub Pages when changes are pushed to the `main` branch. The workflow:
+
+1. Builds the documentation using mdBook
+2. Deploys to GitHub Pages
+3. Available at: https://coder.github.io/httpjail/
+
+## Resources
+
+- [mdBook Documentation](https://rust-lang.github.io/mdBook/)
+- [mdBook GitHub](https://github.com/rust-lang/mdBook)
+- [CommonMark Spec](https://commonmark.org/) (Markdown standard)

book.toml

@@ -0,0 +1,47 @@
+[book]
+authors = ["Ammar Bandukwala"]
+language = "en"
+multilingual = false
+src = "docs"
+title = "httpjail"
+description = "HTTP(S) Request Jailing: Control what your processes can request"
+
+[build]
+build-dir = "book"
+
+[preprocessor.index]
+
+[preprocessor.links]
+
+[output.html]
+default-theme = "rust"
+preferred-dark-theme = "navy"
+git-repository-url = "https://github.com/coder/httpjail"
+git-repository-icon = "fa-github"
+edit-url-template = "https://github.com/coder/httpjail/edit/main/{path}"
+site-url = "https://coder.github.io/httpjail/"
+cname = ""
+mathjax-support = false
+copy-fonts = true
+additional-css = []
+additional-js = []
+no-section-label = false
+fold.enable = true
+fold.level = 0
+playground.copyable = true
+playground.copy-js = true
+playground.line-numbers = false
+playground.editable = false
+
+[output.html.search]
+enable = true
+limit-results = 30
+teaser-word-count = 30
+use-boolean-and = true
+boost-title = 2
+boost-hierarchy = 1
+boost-paragraph = 1
+expand = true
+heading-split-level = 3
+
+[output.html.redirect]

docs/SUMMARY.md

@@ -0,0 +1,43 @@
+# Summary
+
+[Introduction](./introduction.md)
+
+# User Guide
+
+- [Installation](./guide/installation.md)
+- [Quick Start](./guide/quick-start.md)
+- [Configuration](./guide/configuration.md)
+  - [JavaScript Rules](./guide/javascript-rules.md)
+  - [Shell Scripts](./guide/shell-scripts.md)
+  - [Request Logging](./guide/request-logging.md)
+- [Platform Support](./guide/platform-support.md)
+  - [Linux](./guide/linux.md)
+  - [macOS](./guide/macos.md)
+- [Security](./guide/security.md)
+
+# Reference
+
+- [Command Line Options](./reference/cli.md)
+- [Environment Variables](./reference/environment.md)
+- [JavaScript API](./reference/javascript-api.md)
+- [Exit Codes](./reference/exit-codes.md)
+
+# Advanced
+
+- [Architecture](./advanced/architecture.md)
+- [TLS Interception](./advanced/tls-interception.md)
+- [Network Namespaces](./advanced/network-namespaces.md)
+- [DNS Protection](./advanced/dns-protection.md)
+- [Server Mode](./advanced/server-mode.md)
+
+# Development
+
+- [Building from Source](./development/building.md)
+- [Testing](./development/testing.md)
+- [Contributing](./development/contributing.md)
+- [CI/CD](./development/ci-cd.md)
+
+---
+
+[Security Policy](./security-policy.md)
+[License](./license.md)

docs/advanced/architecture.md

@@ -0,0 +1 @@
+# Architecture

docs/advanced/dns-protection.md

@@ -0,0 +1 @@
+# DNS Protection

docs/advanced/network-namespaces.md

@@ -0,0 +1 @@
+# Network Namespaces

docs/advanced/server-mode.md

@@ -0,0 +1 @@
+# Server Mode

docs/advanced/tls-interception.md

@@ -0,0 +1 @@
+# TLS Interception