Some docs tweaks

[nicktrn]

• v4 tag for playwirght extension
• self-hosting architecture section with sexy image ©️ @samejr
• v4-beta tag warning for self-hosters

[changeset-bot]

⚠️ No Changeset found

Latest commit: ee0b315

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

[coderabbitai]

Walkthrough

The documentation was updated in several areas. The Playwright build extension documentation now includes a new "v4" metadata tag and displays an upgrade note component at the top. In the self-hosting Docker documentation, a warning was added after the CLI initialization example, advising users to use the "v4-beta" tag during the beta period instead of "latest." The self-hosting overview documentation received a new architecture section, detailing the deployment structure as two main scalable components (Webapp and Worker) and adding an architecture diagram. No changes were made to any exported or public entities.

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Explain this complex logic.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai explain this code block.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and explain its main purpose.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (2)

docs/self-hosting/docker.mdx (1)

108-110: Clarify the scope of the warning and correct terminology
The note states “commands displayed in the webapp are incorrect,” but the snippet refers to CLI commands. Consider rephrasing to “commands displayed in the UI” or explicitly mention where users will see the incorrect tags to avoid confusion.

docs/self-hosting/overview.mdx (1)

22-29: Add descriptive alt text and ensure image path resolution
The architecture diagram uses ![Self-hosting architecture](./architecture.png). Consider making the alt text more descriptive (e.g., “Self-hosted Trigger.dev architecture diagram”) and verify that architecture.png is placed next to this file so the relative path resolves correctly.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between fb9abe5 and ee0b315.

⛔ Files ignored due to path filters (1)

• docs/self-hosting/architecture.png is excluded by !**/*.png

📒 Files selected for processing (3)

• docs/config/extensions/playwright.mdx (1 hunks)
• docs/self-hosting/docker.mdx (1 hunks)
• docs/self-hosting/overview.mdx (1 hunks)

⏰ Context from checks skipped due to timeout of 90000ms (3)

• GitHub Check: Analyze (python)
• GitHub Check: Analyze (actions)
• GitHub Check: Analyze (javascript-typescript)

🔇 Additional comments (2)

docs/config/extensions/playwright.mdx (2)

5-6: Verify use of frontmatter key for tags
Frontmatter uses tag: "v4", but our docs convention expects tags: (plural) to enable filtering and categorization. Please confirm and update to tags: if needed to ensure the documentation site picks up this metadata.

---

8-11: Confirm snippet import path and component existence
You’ve imported <UpgradeToV4Note /> from /snippets/upgrade-to-v4-note.mdx. Please verify that this file exists at the specified path and that the site build resolves leading-slash imports correctly.