Skip to content

Commit a69ce81

Browse files
committed
docs: add MkDocs documentation site with GitHub Pages deployment
- Add comprehensive docs pages (quick-start, auth, troubleshooting, etc.) - Add GitHub Pages workflow and CI docs build job - Streamline README by moving detailed content to docs site
1 parent 33bedb9 commit a69ce81

19 files changed

Lines changed: 1400 additions & 191 deletions

.github/workflows/ci.yml

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,3 +43,23 @@ jobs:
4343
run: |
4444
chmod +x scripts/version-check.sh
4545
./scripts/version-check.sh
46+
47+
docs:
48+
name: Docs Build
49+
runs-on: ubuntu-latest
50+
steps:
51+
- name: Checkout
52+
uses: actions/checkout@v4
53+
54+
- name: Set up Python
55+
uses: actions/setup-python@v5
56+
with:
57+
python-version: "3.x"
58+
59+
- name: Install MkDocs
60+
run: |
61+
python -m pip install --upgrade pip
62+
python -m pip install -r docs-requirements.txt
63+
64+
- name: Build docs
65+
run: mkdocs build --strict

.github/workflows/pages.yml

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
name: Pages
2+
3+
on:
4+
push:
5+
branches: [ main ]
6+
workflow_dispatch:
7+
8+
permissions:
9+
contents: read
10+
pages: write
11+
id-token: write
12+
13+
concurrency:
14+
group: pages
15+
cancel-in-progress: true
16+
17+
jobs:
18+
build:
19+
name: Build Docs Site
20+
runs-on: ubuntu-latest
21+
steps:
22+
- name: Checkout
23+
uses: actions/checkout@v4
24+
25+
- name: Configure Pages
26+
uses: actions/configure-pages@v5
27+
28+
- name: Set up Python
29+
uses: actions/setup-python@v5
30+
with:
31+
python-version: "3.x"
32+
33+
- name: Install MkDocs
34+
run: |
35+
python -m pip install --upgrade pip
36+
python -m pip install -r docs-requirements.txt
37+
38+
- name: Build site
39+
run: mkdocs build --strict
40+
41+
- name: Remove unpublished artifacts
42+
run: rm -rf site/devlog
43+
44+
- name: Upload artifact
45+
uses: actions/upload-pages-artifact@v3
46+
with:
47+
path: site
48+
49+
deploy:
50+
name: Deploy Docs Site
51+
if: github.ref == 'refs/heads/main'
52+
needs: build
53+
runs-on: ubuntu-latest
54+
environment:
55+
name: github-pages
56+
url: ${{ steps.deployment.outputs.page_url }}
57+
steps:
58+
- name: Deploy to GitHub Pages
59+
id: deployment
60+
uses: actions/deploy-pages@v4

.gitignore

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -150,3 +150,6 @@ claude-yolo-pro/
150150

151151
# Claude YOLO Config Files - Local overrides
152152
.claude-yolo.local
153+
154+
# MkDocs output
155+
site/

CHANGELOG.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Changelog
22

3-
All notable changes to Claude Code YOLO will be documented in this file.
3+
All notable changes to deva.sh will be documented in this file.
44

55
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
66
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
@@ -11,16 +11,21 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
1111
- `LICENSE` with the standard MIT license text
1212
- `SECURITY.md` with private vulnerability reporting guidance
1313
- `CONTRIBUTING.md` with the repo workflow, local checks, and release rules
14+
- `docs/` guide set for quick start, internals, philosophy, authentication, advanced usage, and troubleshooting
15+
- `mkdocs.yml`, `docs/index.md`, and GitHub Pages workflow for publishing the docs site
1416

1517
### Fixed
1618
- Claude `--auth-with api-key` now forwards `ANTHROPIC_AUTH_TOKEN` and `ANTHROPIC_BASE_URL`
1719
- Non-default auth no longer moves live host credential files out of the way; it overlays the default credential path with a safe placeholder instead
1820
- `--dry-run` no longer mutates config homes through autolink or scaffold writes
21+
- Copilot `--dry-run` no longer starts the local proxy as a side effect
1922
- Config-home fan-out skips loose credential files, backup files, VCS junk, and `.DS_Store`
23+
- Auth-specific persistent containers now include the agent in the name suffix, avoiding cross-agent reuse with the wrong env or mounts
2024
- `install.sh` now installs the full current agent set, including Gemini and `shared_auth.sh`
2125

2226
### Changed
23-
- Rewrote `README.md` into a cleaner OSS landing page with badges, quick start, auth matrix, and security warnings
27+
- Rewrote `README.md` into a deva.sh front page with a real docs index and sharper OSS positioning
28+
- CI now builds the MkDocs site so Pages breakage gets caught before merge
2429
- Updated `workflows/RELEASE.md` to use `deva.sh` as the source of truth for version bumps
2530

2631
## [0.9.1] - 2026-01-09

CONTRIBUTING.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,8 @@ If you change Docker image behavior, auth flows, or release logic, test those pa
4949

5050
Update docs when behavior changes:
5151

52-
- `README.md` for user-facing workflow
52+
- `README.md` for the front page and project positioning
53+
- `docs/` for long-form user guides
5354
- `CHANGELOG.md` for release notes
5455
- `DEV-LOGS.md` for significant work
5556
- `SECURITY.md` when the reporting path or threat model changes

DEV-LOGS.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,18 @@
1313
- Minimal markdown markers, no unnecessary formatting, minimal emojis.
1414
- Reference issue numbers in the format `#<issue-number>` for easy linking.
1515

16+
# [2026-03-11] Dev Log: deva.sh docs spine for OSS release
17+
- Why: the repo had a decent landing page but still dumped too much context into one README and did not read like an organized OSS project
18+
- What:
19+
- rewrote `README.md` as the deva.sh front page instead of a giant mixed-purpose document
20+
- added `docs/index.md`, `docs/quick-start.md`, `docs/how-it-works.md`, `docs/philosophy.md`, `docs/authentication.md`, `docs/advanced-usage.md`, and `docs/troubleshooting.md`
21+
- revalidated the docs against real `--dry-run` output instead of just `--help`
22+
- corrected the docs and CLI help to describe persistent containers as project-scoped shapes, not a naive single-container story
23+
- fixed auth-specific persistent naming to include the agent and fixed Copilot `--dry-run` so it no longer starts the proxy
24+
- added MkDocs config, a GitHub Pages deploy workflow, a dedicated docs site home page, and CI docs-build validation
25+
- aligned `CHANGELOG.md` and contribution guidance with the new docs split
26+
- Result: the repo now has an actual docs spine for onboarding, internals, auth, and advanced workflows, the documented behavior matches the observed runtime shape, and the repo is ready to publish docs through GitHub Pages
27+
1628
# [2026-03-11] Dev Log: OSS repo polish and auth mount cleanup
1729
- Why: the repo still looked half-finished in public, the installer lagged behind the actual agent set, and recent auth switching work exposed ugly mount behavior
1830
- What:

0 commit comments

Comments
 (0)