New Documentation Site #37
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Implements a complete documentation site using MkDocs with Material theme, to be hosted at docs.cub.tools via GitHub Pages. Site structure: - Getting Started: installation, quickstart, concepts, upgrading - User Guide: configuration, tasks, run loop, prep pipeline, harnesses, git integration, hooks, budget/guardrails, advanced features - CLI Reference: all 32 commands with examples - Troubleshooting: common issues, error reference, FAQ - Contributing: architecture, setup, extending harnesses/backends Features: - Custom CSS matching landing page color palette (honey/coral/mint) - Dark mode support with proper theme colors - GitHub Actions workflow for automatic deployment - Search, code copy, tabbed content, admonitions - 78 documentation pages covering full feature set Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
- Move all MkDocs content from docs-site/ to docs/content/ - Update mkdocs.yml with docs_dir: content, site_dir: site - Update GitHub Actions to build from docs/ and deploy landing + docs - Change CNAME from install.cub.tools to docs.cub.tools - Update install.sh URL to https://docs.cub.tools/install.sh - Remove legacy markdown files (CONFIG.md, HARNESSES.md, etc.) - Update landing page docs link to /docs/ Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
Move MkDocs source files to docs-src/ to prevent accidental exposure: - docs/ now contains only public files (index.html, install.sh, CNAME, assets/) - docs-src/ contains MkDocs source (mkdocs.yml, content/, includes/, overrides/) - Update GitHub Actions workflow to build from docs-src/ - Update edit_uri to point to docs-src/content/ This separation ensures mkdocs.yml, requirements.txt, and source markdown are never served publicly, even if GitHub Pages config changes. Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
PR body now includes: - Commit list with short SHA and subject - Diff statistics (files changed, insertions, deletions) - Files changed grouped by type (added/modified/deleted) - Truncation for large file lists (shows first 10 + "... and N more") Added new GitHubClient methods: - get_commits_between(): Get commits between base and head branches - get_files_changed(): Get files added/modified/deleted between branches - get_diff_stat(): Get diff statistics (files, insertions, deletions) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
The MkDocs custom_dir setting references the overrides directory, but Git doesn't track empty directories. This caused CI to fail with "The path set in custom_dir does not exist". Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
Code reviewNo issues found. Checked for bugs and CLAUDE.md compliance. |
Resolves conflict in docs/CONFIG.md by keeping deletion (docs moved to MkDocs) and adding async_notifications documentation to MkDocs config reference. Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
Pull Request
Stats: 130 file(s) changed, +30750, -3029
Changes
Commits (17)
4823441fix: cub pr now generates informative PR descriptions (fixes bug: cub pr should create an informative message #36)8ba521edocs: separate MkDocs source from public landing pagef7f8725docs: consolidate docs-site into docs/, serve from docs.cub.tools2964730docs: add MkDocs Material documentation site7ad06e9docs: update webpage for v0.26.3282b8f5chore: bump version to 0.26.38aa93baci: lower coverage threshold to 53%07df8bdfix: reorganize CLI help - move doctor to install, expose sandbox/worktree309d601feat: consolidate cub pr and add cub merge commands (Python)11c90fcfix: cub sessions output alignment (fixes bug: cub sessions output doesn't line up #31)2125f4dadded support for working through github issues in cub run3d3403afix: ensure streaming output flushes properly for real-time display (fixes bug: cub run --stream doesn't insert line breaks #34)9cf8944feat(release): pass release title to webpage updatercd5aebenow using vanity url and updated hero imgbdf18dddocs: update webpage for v0.26.20e4b561chore: bump version to 0.26.26543b65Non-interactive mode for cub prep steps (Non-interactive mode for cub prep steps #33)Files Changed
Added (105):
.github/workflows/docs.yml,docs-src/.gitignore,docs-src/content/assets/images/cub-logo.png,docs-src/content/assets/images/favicon.ico,docs-src/content/changelog.md,docs-src/content/cli/artifacts.md,docs-src/content/cli/branch.md,docs-src/content/cli/branches.md,docs-src/content/cli/capture.md,docs-src/content/cli/captures.md, ... and 95 moreModified (19):
.beads/branches.yaml,.github/workflows/test.yml,CHANGELOG.md,README.md,docs/CNAME,docs/index.html,docs/install.sh,pyproject.toml,scripts/cut-release.sh,scripts/release-pipeline.sh, ... and 9 moreDeleted (6):
docs/CONFIG.md,docs/HARNESSES.md,docs/QUICK_START.md,docs/TROUBLESHOOTING.md,docs/UPGRADING.md,src/cub/bash/lib/cmd_pr.shTest Plan
Generated with cub