Skip to content

chore: docs deployment - #209

Merged
santoshyadavdev merged 1 commit into
mainfrom
try-docs-deployment
Oct 3, 2026
Merged

santoshyadavdev merged 1 commit into
mainfrom
try-docs-deployment

Conversation

@santoshyadavdev

@santoshyadavdev santoshyadavdev commented Oct 3, 2026 •

Copy link
Copy Markdown
Owner

What and why

How it was verified

  • pnpm commit:check (commit messages follow the guidelines)
  • pnpm format:check
  • pnpm typecheck (includes the ngc template checks)
  • pnpm test, pnpm test:devtools and pnpm test:panel
  • pnpm skills:check (when .claude/ changed)
  • Docs in apps/docs updated and pnpm docs:build passes (when behavior, options, UI labels or agent tools changed), or the no-docs label added with the reason below
  • pnpm extension:build and extension/ui committed (when app/ changed)
  • Checked in the browser with axe (when the UI changed)

Screenshots

Notes for reviewers

Summary by CodeRabbit

  • New Features
    • Added a deployment command for publishing the documentation site as static pages.
    • Configured the documentation site to serve prerendered pages and show a 404 page for missing paths.
  • Documentation
    • Updated build output and deployment instructions, including Cloudflare authentication steps.

@cloudflare-workers-and-pages

cloudflare-workers-and-pages Bot commented Oct 3, 2026 •

Copy link
Copy Markdown

🚀 Deploying Preview to Cloudflare 🚀

Preview Deployments by commit

Status Deployment URL Commit Updated (UTC) See this deployment's details
  • Build: Failed ❌

View logs ↗
697f622 2026-10-03T10:40:07.616Z View logs ↗

@github-actions github-actions Bot added the area: docs The documentation site label Oct 3, 2026
@coderabbitai

coderabbitai Bot commented Oct 3, 2026 •

Copy link
Copy Markdown
Contributor

Review in Change Stack →

Navigate logical layers of code changes, visualize relationships, and explore their blast radius.

🧰 Additional context used
📚 Code guidelines (1)
AGENTS.md — auto-discovered

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration
  • Configuration used: Organization UI
  • Review profile: ASSERTIVE
  • Plan: Essentials
  • Run ID: b4f02de5-5bc1-4ac5-9dae-eba7b1d514f4
📥 Commits

Reviewing files that changed from the base of the PR and between ba918d2 and 697f622.

⛔ Files ignored due to path filters (1)
  • pnpm-lock.yaml is excluded by !**/pnpm-lock.yaml
📒 Files selected for processing (7)
  • .gitignore
  • apps/docs/README.md
  • apps/docs/package.json
  • apps/docs/project.json
  • apps/docs/vite.config.ts
  • apps/docs/wrangler.jsonc
  • package.json

Included review availability: This review used your included allowance. 4 included reviews remain after this review. Your included PR review attempts over the past 7 days set your current allowance at 5 reviews per hour.


📝 Walkthrough

Walkthrough

The docs build output now uses dist/apps/docs. New Nx and Wrangler configuration adds a deployment command that serves prerendered pages from the build output as static assets.

Changes

Documentation site deployment

Layer / File(s) Summary
Docs build output
apps/docs/vite.config.ts, apps/docs/project.json, .gitignore
Vite and Analog output paths and the Nx build target use dist/apps/docs. Intermediate build files remain under apps/docs/.analog, which is now ignored.
Wrangler deployment
apps/docs/wrangler.jsonc, apps/docs/project.json, apps/docs/package.json, package.json, apps/docs/README.md
The Nx deploy target runs wrangler deploy after the build. Wrangler serves static assets from the prerendered public directory. A root docs:deploy script and README instructions document the deployment command and authentication options.

Priority: ⬇️ Low

Estimated code review effort: 2 (Simple) | ~10 minutes

Change: Feature

Sequence Diagram(s)

sequenceDiagram
  participant User
  participant Nx
  participant ViteAnalog
  participant Wrangler
  User->>Nx: Run docs:deploy
  Nx->>ViteAnalog: Run the build target
  ViteAnalog->>Nx: Write site output to dist/apps/docs
  Nx->>Wrangler: Run wrangler deploy after build
  Wrangler->>Wrangler: Serve configured static assets
Loading

Suggested labels: enhancement

Merge Risk: ⚪ Minimal · up to 697f6

The docs deployment path is configured to publish the generated prerendered assets. No merge-blocking issue is evident, though the build and deployment were not executed.

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Docstring Coverage ⚠️ Warning Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. Docstring coverage is scoped to functions touched by this diff. Analyzed 1 functions across 1 files. (6 skipped: 6 … Write docstrings for the functions missing them to satisfy the coverage threshold.
✅ Passed checks (4 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly and concisely describes the main change: deployment support for the docs project.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Full details: Docstring Coverage

Explanation

Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. Docstring coverage is scoped to functions touched by this diff. Analyzed 1 functions across 1 files. (6 skipped: 6 unsupported.)

  • Fix all pre-merge checks with AI
✨ Finishing Touches 💡 1
📝 Generate docstrings 💡
  • Commit to this branch
  • Create a new PR
🧪 Generate unit tests (beta)
  • Commit to this branch
  • Create a new PR
  • Autopilot · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

A rabbit checks the build output tree,
Then hops where static pages wait to be.
Wrangler takes the public files in flight,
And serves the docs beneath the night.
One neat command; the bunny rests,
With carrot crumbs and deployment tests.

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

@nx-cloud

nx-cloud Bot commented Oct 3, 2026

Copy link
Copy Markdown

View your CI Pipeline Execution ↗ for commit 697f622

Command Status Duration Result
nx affected -t test build ✅ Succeeded 1m 28s View ↗

💡 Verify your cache is correct by running tasks in a sandbox. Read docs ↗


☁️ Nx Cloud last updated this comment at 2026-10-03 10:16:08 UTC

@santoshyadavdev
santoshyadavdev merged commit ab10066 into main Oct 3, 2026
8 of 9 checks passed
@santoshyadavdev
santoshyadavdev deleted the try-docs-deployment branch October 3, 2026 10:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area: docs The documentation site enhancement

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant