Skip to content

Docs#2

Merged
BurnedChris merged 4 commits intomainfrom
docs
Nov 26, 2025
Merged

Docs#2
BurnedChris merged 4 commits intomainfrom
docs

Conversation

@BurnedChris
Copy link
Copy Markdown
Contributor

@BurnedChris BurnedChris commented Nov 26, 2025

Summary by CodeRabbit

  • New Features

    • Comprehensive documentation added covering Getting Started, framework guides (Nitro, Hono, HTTP API), API reference, CLI reference, and architecture.
    • Structured GitHub issue templates for bug reports, feature requests, documentation, performance, regressions, security, and testing issues.
  • Documentation

    • Contributing guidelines with development setup and workflow instructions.
    • OSS documentation including license and contribution guidelines.
  • Chores

    • GitHub Actions workflows for CI/CD, bundle analysis, and automated code formatting.
    • Workspace configuration updates.

✏️ Tip: You can customize this high-level summary in your review settings.

…ty: deleted advanced topics, deployment guide, and writing runners documentation. Introduced new framework-specific guides for Nitro, Hono, and HTTP API, enhancing the overall organization and accessibility of the documentation.
… deployment

- Introduced new GitHub Actions for bundle size analysis and documentation deployment.
- Added configuration files for the bundle analysis action and the c15t GitHub action.
- Created comprehensive README files and issue templates to enhance contribution guidelines and documentation clarity.
- Updated pnpm workspace configuration to include internals for better project organization.
…'c15t-docs' for documentation deployment. This change includes updates to workflow headers, action inputs, and comment handling in tests, ensuring consistency across the codebase.
@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Nov 26, 2025

Caution

Review failed

The pull request is closed.

Walkthrough

This pull request adds comprehensive GitHub Actions workflow automation, documentation, and action implementations. Changes include issue templates, CI/CD workflows, a bundle analysis action, a docs-preview deployment action with PR commenting, and extensive multi-framework documentation covering Nitro, Hono, and HTTP API runners alongside shared guides and API reference.

Changes

Cohort / File(s) Summary
GitHub Configuration
.github/CODEOWNERS, .github/CONTRIBUTING.md, .github/pull_request_template.md
Added repository ownership, contribution guidelines, and PR template for standardized workflows.
GitHub Issue Templates
.github/ISSUE_TEMPLATE/{bug_report,conduct_violation,doc_report,feature_request,performance,regression,security,test}.yml, .github/ISSUE_TEMPLATE/config.yml
Introduced structured issue templates with validation rules for bugs, features, security, performance, regressions, testing, documentation, and conduct violations; disabled blank issues.
GitHub Workflows
.github/workflows/{autofix,bundle-analysis,ci,deploy-docs-production}.yml
Added CI/CD automation for code formatting, bundle analysis, build/test/lint checks, and production docs deployment.
Framework Documentation
docs/frameworks/{nitro,hono,http}/, docs/frameworks/shared/, docs/frameworks/index.mdx, docs/frameworks/meta.json
Comprehensive framework-specific guides covering quickstart, configuration, deployment, orchestration, writing runners, and advanced topics across Nitro, Hono, and HTTP API with shared sections.
Getting Started & Reference
docs/{introduction,getting-started,index}.mdx, docs/meta.json, docs/reference/{api,cli,index}.mdx, docs/reference/meta.json
Added introductory guide, getting-started tutorial, and API/CLI reference documentation with navigation metadata.
OSS Documentation
docs/oss/{contributing,license}.mdx, docs/oss/meta.json
Added open-source contribution guidelines, MIT license, and documentation section metadata.
Bundle Analysis Action
internals/bundle-analysis-action/
Implemented GitHub Action for analyzing and reporting bundle size differences with rsdoctor data, including TypeScript source, tests, configuration, and tooling.
C15T GitHub Action
internals/c15t-github-action/
Implemented comprehensive GitHub Action for docs-preview deployment to Vercel, GitHub PR commenting with sticky comments, GitHub App authentication, error handling with retries, and deployment orchestration.
Workspace & Rust
pnpm-workspace.yaml, packages/runners/schema-extractor/src/{cli,file,types}.rs
Expanded workspace to include internals and docs; added trailing newlines to Rust files for formatting consistency.

Sequence Diagram(s)

sequenceDiagram
    participant GH as GitHub
    participant Action as C15T Action
    participant Vercel as Vercel API
    participant PR as PR Comment
    
    GH->>Action: Trigger (push/PR)
    Action->>Action: Load config & auth
    
    alt GitHub App Auth
        Action->>GH: Request installation token
        GH-->>Action: Installation token
    end
    
    Action->>Action: Determine target (prod/staging)
    Action->>Action: Check deployment policy
    
    alt Policy allows deploy
        Action->>Vercel: Deploy project
        Vercel-->>Action: Deployment URL
        Action->>Action: Render comment markdown
        
        alt Is PR event
            Action->>GH: Find/create sticky comment
            GH-->>PR: Comment created/updated
        else Is push event
            Action->>GH: Create commit comment
            GH-->>PR: Comment created
        end
    else Policy skips deploy
        Action->>Action: Handle skip scenario
        alt postSkipComment enabled
            Action->>GH: Post skip message
        end
    end
    
    Action->>Action: Set outputs & status
Loading
sequenceDiagram
    participant GH as GitHub
    participant BA as Bundle Action
    participant FS as Filesystem
    participant Comment as PR Comment
    
    GH->>BA: Trigger on PR
    BA->>BA: Load config (dirs, threshold)
    BA->>FS: Analyze base branch
    FS-->>BA: Base bundles (rsdoctor)
    BA->>FS: Analyze PR branch
    FS-->>BA: Current bundles (rsdoctor)
    BA->>BA: Compare & generate report
    BA->>FS: Write bundle-diff.md
    
    alt Has PR number
        BA->>Comment: Find previous comment by header
        Comment-->>BA: Comment ID or undefined
        
        alt Comment exists
            BA->>Comment: Update with new report
        else No comment
            BA->>Comment: Create new comment
        end
    end
    
    BA->>BA: Compute total diff %
    alt Total diff exceeds threshold
        BA->>GH: Fail workflow if failOnIncrease
    end
    
    BA->>BA: Set outputs (path, changes, diff%)
Loading

Estimated code review effort

🎯 4 (Complex) | ⏱️ ~75 minutes

Key areas requiring close attention:

  • internals/c15t-github-action/src/deploy/vercel-client.ts — Vercel deployment logic with file walking, lockfile detection, API integration, and alias domain management; edge cases around metadata handling and error recovery should be verified.
  • internals/c15t-github-action/src/steps/deployment.ts — Orchestration of GitHub deployments, environment resolution, gated deployment policy checks, and integration with Vercel; ensure branch detection and target resolution are correct across push and PR events.
  • internals/c15t-github-action/src/github/pr-comment.ts — GitHub GraphQL/REST API interactions for sticky comment lifecycle (create, update, find); header-based comment identification and body merging logic; pagination edge cases.
  • internals/bundle-analysis-action/src/analyze/bundle-analysis.ts — Bundle comparison logic, diff calculation, recursive file discovery, and markdown report generation; validate rsdoctor data parsing and null/zero-size handling.
  • internals/c15t-github-action/src/config/inputs.ts — Extensive input configuration with GitHub context integration and async file glob resolution; ensure all inputs have proper defaults and type safety.
  • GitHub Actions workflow files (.github/workflows/{ci,bundle-analysis,deploy-docs-production}.yml) — Verify job dependencies, permission scopes, secret/token handling, caching strategies, and artifact uploads.

Poem

🐰 Docs and workflows, now they flow,
With actions bundled in a row,
From Vercel clouds to comments sweet,
Our framework guide is now complete!
Tests pass, builds ship, the web runs fast—
This pull request's no fleeting task!

✨ Finishing touches
  • 📝 Generate docstrings
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch docs

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: ASSERTIVE

Plan: Pro

Disabled knowledge base sources:

  • Linear integration is disabled by default for public repositories

You can enable these sources in your CodeRabbit configuration.

📥 Commits

Reviewing files that changed from the base of the PR and between 8576bf4 and 90553d0.

⛔ Files ignored due to path filters (1)
  • pnpm-lock.yaml is excluded by !**/pnpm-lock.yaml
📒 Files selected for processing (105)
  • .github/CODEOWNERS (1 hunks)
  • .github/CONTRIBUTING.md (1 hunks)
  • .github/ISSUE_TEMPLATE/bug_report.yml (1 hunks)
  • .github/ISSUE_TEMPLATE/conduct_violation.yml (1 hunks)
  • .github/ISSUE_TEMPLATE/config.yml (1 hunks)
  • .github/ISSUE_TEMPLATE/doc_report.yml (1 hunks)
  • .github/ISSUE_TEMPLATE/feature_request.yml (1 hunks)
  • .github/ISSUE_TEMPLATE/performance.yml (1 hunks)
  • .github/ISSUE_TEMPLATE/regression.yml (1 hunks)
  • .github/ISSUE_TEMPLATE/security.yml (1 hunks)
  • .github/ISSUE_TEMPLATE/test.yml (1 hunks)
  • .github/pull_request_template.md (1 hunks)
  • .github/workflows/autofix.yml (1 hunks)
  • .github/workflows/bundle-analysis.yml (1 hunks)
  • .github/workflows/ci.yml (1 hunks)
  • .github/workflows/deploy-docs-production.yml (1 hunks)
  • docs/architecture.mdx (1 hunks)
  • docs/frameworks/hono/advanced.mdx (1 hunks)
  • docs/frameworks/hono/configuration.mdx (1 hunks)
  • docs/frameworks/hono/deployment.mdx (1 hunks)
  • docs/frameworks/hono/meta.json (1 hunks)
  • docs/frameworks/hono/orchestration.mdx (1 hunks)
  • docs/frameworks/hono/quickstart.mdx (1 hunks)
  • docs/frameworks/hono/writing-runners.mdx (1 hunks)
  • docs/frameworks/http/advanced.mdx (1 hunks)
  • docs/frameworks/http/deployment.mdx (1 hunks)
  • docs/frameworks/http/meta.json (1 hunks)
  • docs/frameworks/http/orchestration.mdx (1 hunks)
  • docs/frameworks/http/quickstart.mdx (1 hunks)
  • docs/frameworks/http/writing-runners.mdx (1 hunks)
  • docs/frameworks/index.mdx (1 hunks)
  • docs/frameworks/meta.json (1 hunks)
  • docs/frameworks/nitro/advanced.mdx (1 hunks)
  • docs/frameworks/nitro/configuration.mdx (1 hunks)
  • docs/frameworks/nitro/deployment.mdx (1 hunks)
  • docs/frameworks/nitro/meta.json (1 hunks)
  • docs/frameworks/nitro/orchestration.mdx (1 hunks)
  • docs/frameworks/nitro/quickstart.mdx (1 hunks)
  • docs/frameworks/nitro/writing-runners.mdx (1 hunks)
  • docs/frameworks/shared/advanced.mdx (1 hunks)
  • docs/frameworks/shared/orchestration.mdx (1 hunks)
  • docs/frameworks/shared/writing-runners.mdx (1 hunks)
  • docs/getting-started.mdx (1 hunks)
  • docs/index.mdx (1 hunks)
  • docs/introduction.mdx (1 hunks)
  • docs/meta.json (1 hunks)
  • docs/oss/contributing.mdx (1 hunks)
  • docs/oss/license.mdx (1 hunks)
  • docs/oss/meta.json (1 hunks)
  • docs/reference/api.mdx (1 hunks)
  • docs/reference/cli.mdx (1 hunks)
  • docs/reference/index.mdx (1 hunks)
  • docs/reference/meta.json (1 hunks)
  • internals/bundle-analysis-action/README.md (1 hunks)
  • internals/bundle-analysis-action/action.yml (1 hunks)
  • internals/bundle-analysis-action/package.json (1 hunks)
  • internals/bundle-analysis-action/src/analyze/bundle-analysis.test.ts (1 hunks)
  • internals/bundle-analysis-action/src/analyze/bundle-analysis.ts (1 hunks)
  • internals/bundle-analysis-action/src/config/inputs.ts (1 hunks)
  • internals/bundle-analysis-action/src/github/pr-comment.test.ts (1 hunks)
  • internals/bundle-analysis-action/src/github/pr-comment.ts (1 hunks)
  • internals/bundle-analysis-action/src/main.test.ts (1 hunks)
  • internals/bundle-analysis-action/src/main.ts (1 hunks)
  • internals/bundle-analysis-action/tsconfig.json (1 hunks)
  • internals/bundle-analysis-action/vitest.config.ts (1 hunks)
  • internals/c15t-github-action/README.md (1 hunks)
  • internals/c15t-github-action/__tests__/ascii-art.test.ts (1 hunks)
  • internals/c15t-github-action/__tests__/assets/result (1 hunks)
  • internals/c15t-github-action/__tests__/assets/result2 (1 hunks)
  • internals/c15t-github-action/__tests__/changes.test.ts (1 hunks)
  • internals/c15t-github-action/__tests__/comment.test.ts (1 hunks)
  • internals/c15t-github-action/__tests__/comments.test.ts (1 hunks)
  • internals/c15t-github-action/__tests__/config.test.ts (1 hunks)
  • internals/c15t-github-action/__tests__/deployment.test.ts (1 hunks)
  • internals/c15t-github-action/__tests__/errors.test.ts (1 hunks)
  • internals/c15t-github-action/__tests__/improvements.test.ts (1 hunks)
  • internals/c15t-github-action/__tests__/logger.test.ts (1 hunks)
  • internals/c15t-github-action/__tests__/push-comment.test.ts (1 hunks)
  • internals/c15t-github-action/__tests__/render-comment.test.ts (1 hunks)
  • internals/c15t-github-action/__tests__/validate.test.ts (1 hunks)
  • internals/c15t-github-action/__tests__/vercel-client.test.ts (1 hunks)
  • internals/c15t-github-action/action.yml (1 hunks)
  • internals/c15t-github-action/package.json (1 hunks)
  • internals/c15t-github-action/src/config/inputs.ts (1 hunks)
  • internals/c15t-github-action/src/deploy/vercel-client.ts (1 hunks)
  • internals/c15t-github-action/src/github/pr-comment.ts (1 hunks)
  • internals/c15t-github-action/src/main.ts (1 hunks)
  • internals/c15t-github-action/src/steps/ascii-art.ts (1 hunks)
  • internals/c15t-github-action/src/steps/changes.ts (1 hunks)
  • internals/c15t-github-action/src/steps/comments.ts (1 hunks)
  • internals/c15t-github-action/src/steps/deployment.ts (1 hunks)
  • internals/c15t-github-action/src/steps/first-commit.ts (1 hunks)
  • internals/c15t-github-action/src/steps/github-app-auth.ts (1 hunks)
  • internals/c15t-github-action/src/steps/push-comment.ts (1 hunks)
  • internals/c15t-github-action/src/steps/render-comment.ts (1 hunks)
  • internals/c15t-github-action/src/steps/setup-docs.ts (1 hunks)
  • internals/c15t-github-action/src/steps/template-tracking.ts (1 hunks)
  • internals/c15t-github-action/src/utils/errors.ts (1 hunks)
  • internals/c15t-github-action/src/utils/logger.ts (1 hunks)
  • internals/c15t-github-action/tsconfig.json (1 hunks)
  • internals/c15t-github-action/vitest.config.ts (1 hunks)
  • packages/runners/schema-extractor/src/cli.rs (1 hunks)
  • packages/runners/schema-extractor/src/file.rs (1 hunks)
  • packages/runners/schema-extractor/src/types.rs (1 hunks)
  • pnpm-workspace.yaml (1 hunks)

Comment @coderabbitai help to get the list of available commands and usage tips.

@BurnedChris BurnedChris merged commit f26959a into main Nov 26, 2025
1 of 4 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.

1 participant