chore(docs): Admin requirements for creating worker groups #2925
Conversation
|
WalkthroughDocumentation updates across multiple guides: added warnings in the Puppeteer example prohibiting screenshots; added a new "Creating additional worker groups" section in the Docker self-hosting guide with admin setup and curl examples for creating worker groups (notes that a token is returned on creation); clarified that ADMIN_EMAILS applies at signup and does not affect existing users; and revised deployment/environment wording to encourage preview branches for isolated environments and to specify prod/staging environment naming in deployment instructions. Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 minutes 🚥 Pre-merge checks | ✅ 2 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (2 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. 📜 Recent review detailsConfiguration used: Repository UI Review profile: CHILL Plan: Pro 📒 Files selected for processing (2)
🧰 Additional context used🧠 Learnings (16)📚 Learning: 2025-11-27T16:27:35.304ZApplied to files:
📚 Learning: 2025-06-06T23:55:01.933ZApplied to files:
📚 Learning: 2025-08-19T09:49:07.011ZApplied to files:
📚 Learning: 2025-11-10T09:09:07.399ZApplied to files:
📚 Learning: 2025-11-27T16:26:58.661ZApplied to files:
📚 Learning: 2025-06-25T13:20:17.174ZApplied to files:
📚 Learning: 2025-11-27T16:27:35.304ZApplied to files:
📚 Learning: 2025-11-27T16:27:35.304ZApplied to files:
📚 Learning: 2025-06-25T14:14:11.965ZApplied to files:
📚 Learning: 2025-11-27T16:27:35.304ZApplied to files:
📚 Learning: 2025-11-27T16:27:35.304ZApplied to files:
📚 Learning: 2025-10-08T11:48:12.327ZApplied to files:
📚 Learning: 2025-11-27T16:27:35.304ZApplied to files:
📚 Learning: 2025-11-27T16:27:35.304ZApplied to files:
📚 Learning: 2025-08-14T10:35:38.344ZApplied to files:
📚 Learning: 2025-06-06T16:54:23.316ZApplied to files:
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
🔇 Additional comments (2)
✏️ Tip: You can disable this entire section by setting 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. Comment |
Review CompleteYour review story is ready! Comment !reviewfast on this PR to re-generate the story. |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Fix all issues with AI agents
In `@docs/guides/examples/puppeteer.mdx`:
- Around line 153-157: The shared snippet web-scraping-warning.mdx is missing
the sentence "Screenshots are also prohibited when scraping."—update that
snippet to match the local warning in docs/guides/examples/puppeteer.mdx by
adding the exact sentence into the <Warning> block so all pages importing
/snippets/web-scraping-warning.mdx consistently state that screenshots are
prohibited when scraping.
🧹 Nitpick comments (1)
docs/self-hosting/docker.mdx (1)
187-210: LGTM!The new section clearly documents how to create additional worker groups via the admin API. The instructions for making users admin are consistent with the updated
ADMIN_EMAILSdescription inwebapp.mdx.Consider adding an example of the expected response format (especially showing the
tokenfield mentioned in line 209) to help users understand what to look for:The response includes a `token` field if the worker group is newly created: \`\`\`json { "id": "...", "name": "my-worker", "token": "tr_wgt_..." } \`\`\`
📜 Review details
Configuration used: Repository UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (3)
docs/guides/examples/puppeteer.mdxdocs/self-hosting/docker.mdxdocs/self-hosting/env/webapp.mdx
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
- GitHub Check: Mintlify Deployment
🔇 Additional comments (1)
docs/self-hosting/env/webapp.mdx (1)
145-145: LGTM!The clarification that
ADMIN_EMAILSonly applies at signup and does not affect existing users is helpful. This aligns well with the new documentation indocker.mdxthat explains existing users must be promoted via the database.
✏️ Tip: You can disable this entire section by setting review_details to false in your review settings.
| <Warning> | ||
| When web scraping, you MUST use the technique below which uses a proxy with Puppeteer. Direct | ||
| scraping without using `browserWSEndpoint` is prohibited and will result in account suspension. | ||
| Screenshots are also prohibited when scraping. | ||
| </Warning> |
There was a problem hiding this comment.
🧩 Analysis chain
🏁 Script executed:
#!/bin/bash
# Check if the shared ScrapingWarning snippet also includes the screenshot prohibition
fd -t f "web-scraping-warning.mdx" --exec cat {}Repository: triggerdotdev/trigger.dev
Length of output: 437
Update the shared warning snippet for consistency.
The local warning block at lines 153-157 correctly includes "Screenshots are also prohibited when scraping." However, the shared snippet at /snippets/web-scraping-warning.mdx does not contain this policy. Update the shared snippet to include the screenshot prohibition so the policy is communicated consistently across all pages that import it.
🤖 Prompt for AI Agents
In `@docs/guides/examples/puppeteer.mdx` around lines 153 - 157, The shared
snippet web-scraping-warning.mdx is missing the sentence "Screenshots are also
prohibited when scraping."—update that snippet to match the local warning in
docs/guides/examples/puppeteer.mdx by adding the exact sentence into the
<Warning> block so all pages importing /snippets/web-scraping-warning.mdx
consistently state that screenshots are prohibited when scraping.
Adds documentation for creating additional worker groups via the admin API endpoint, including how to make users admin (new vs existing users), and clarifies that ADMIN_EMAILS only applies on signup.