Skip to content

Conversation

@icook
Copy link
Owner

@icook icook commented Dec 20, 2025

Summary

  • Add TypeDoc for TypeScript API documentation
  • Add cargo doc integration for Rust API documentation
  • Migrate from GitHub Pages to Cloudflare Pages for hosting
  • Add just docs, just docs-rust, just docs-ts recipes for local preview

Changes

  1. Documentation generation: TypeDoc config, justfile recipes
  2. CI migration: Replace gh-pages deployment with Cloudflare Pages, add build-docs job

Test Plan

  • CI passes (build-docs job runs successfully)
  • Cloudflare deployment succeeds
  • PR comment shows links to all reports including docs
  • Landing page shows API Documentation section
  • just docs works locally

Closes #215

🤖 Generated with Claude Code

icook and others added 5 commits December 20, 2025 11:09
The explicit `ENV PATH="/usr/local/cargo/bin:${PATH}"` line is unnecessary
because the base image (lukemathwalker/cargo-chef) already includes
/usr/local/cargo/bin in PATH. This was verified by testing that cargo
commands remain available in the final image without this override.

Closes #22

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

Co-Authored-By: Claude Opus 4.5 <[email protected]>
🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Opus 4.5 <[email protected]>
- Add TypeDoc dependency and configuration
- Add justfile recipes: docs, docs-rust, docs-ts
- Configure TypeDoc to exclude tests and internal modules

Part of #215

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

Co-Authored-By: Claude Opus 4.5 <[email protected]>
- Replace gh-pages branch deployment with Cloudflare Pages
- Add build-docs CI job for cargo doc and TypeDoc
- Deploy rust-docs and ts-docs alongside existing reports
- Update PR comments with documentation links
- Remove cleanup-pr-previews.yml (CF handles automatically)

Closes #215

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

Co-Authored-By: Claude Opus 4.5 <[email protected]>
@github-actions
Copy link
Contributor

github-actions bot commented Dec 20, 2025

🏛️ CI Reports

📋 All Reports

📚 API Documentation

🦀 Rust API Docs 📘 TypeScript Docs

🧪 Test Artifacts

📊 Coverage 📚 Storybook
🎭 Playwright

🤖 Generated from commit 2715956

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

Co-Authored-By: Claude Opus 4.5 <[email protected]>
- Add dark mode support
- Fix commit SHA display
- Add detailed build info (branch, workflow run)
- Add coverage percentage indicator
- Add API Schemas section (GraphQL, OpenAPI)
- Make PR comment hierarchical with emojis
- Add link to index page in PR comment

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

Co-Authored-By: Claude Opus 4.5 <[email protected]>
icook and others added 2 commits December 20, 2025 16:00
Coverage data is in vitest subdirectory

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

Co-Authored-By: Claude Opus 4.5 <[email protected]>
- Add logo and favicon
- Build info as prominent header (commit, branch, time, workflow)
- Coverage badge in header with percentage
- Card-based layout for all sections
- Better dark mode styling
- Direct links to Vitest/Playwright/Rust coverage reports

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

Co-Authored-By: Claude Opus 4.5 <[email protected]>
Display coverage percentages for each module (api, components, features,
pages, theme) in a table on the landing page, showing lines covered
and total for each.

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

Co-Authored-By: Claude Opus 4.5 <[email protected]>
…eport

- Replace module-level coverage with test-type coverage table
- Show Lines/Branches/Functions for Vitest, Playwright, Rust
- Remove API Schemas section from landing page (still in coverage report)
- Add 'Back to Developer Resources' link in coverage report
- Clean up unused CSS
- Download rust-coverage artifact separately
- Parse LF/LH/FNF/FNH lines from lcov file
- Move artifact cleanup after coverage extraction
@icook icook merged commit 16b4bcb into master Dec 21, 2025
16 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Docs] Publish source-generated docs to GitHub Pages

2 participants