fix: clarify trigger.config.ts requirement in Vercel integration#3512
fix: clarify trigger.config.ts requirement in Vercel integration#3512Prateet-Github wants to merge 1 commit intotriggerdotdev:mainfrom
Conversation
|
|
Caution Review failedThe pull request is closed. ℹ️ Recent review info⚙️ Run configurationConfiguration used: Repository UI Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (1)
WalkthroughThis pull request adds two documentation sections to the Vercel integration guide. The first is a "Quickstart" note inserted in the "How it works" section, reminding readers to complete the Quickstart guide before proceeding, including the creation of Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes ✨ Finishing Touches🧪 Generate unit tests (beta)
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. Review rate limit: 7/8 reviews remaining, refill in 7 minutes and 30 seconds.Comment |
|
Hi @Prateet-Github, thanks for your interest in contributing! This project requires that pull request authors are vouched, and you are not in the list of vouched users. This PR will be closed automatically. See https://github.com/triggerdotdev/trigger.dev/blob/main/CONTRIBUTING.md for more details. |
| </Note> | ||
|
|
||
| <Note> | ||
| Make sure you've completed the [Quickstart](/quickstart) first, including creating your `trigger.config.ts` file. |
There was a problem hiding this comment.
🟡 Broken documentation link: /quickstart should be /quick-start
The new <Note> links to /quickstart, but the actual page file is docs/quick-start.mdx and the navigation in docs/docs.json:26 lists it as "quick-start". There is no redirect from /quickstart to /quick-start in the redirects section of docs/docs.json:618-747. Other docs that link to this page use the correct /quick-start path (e.g., docs/introduction.mdx:9 uses href="/quick-start" and docs/guides/ai-agents/claude-code-trigger.mdx:14 uses /quick-start). This will result in a 404 for users clicking the link.
| Make sure you've completed the [Quickstart](/quickstart) first, including creating your `trigger.config.ts` file. | |
| Make sure you've completed the [Quickstart](/quick-start) first, including creating your `trigger.config.ts` file. |
Was this helpful? React with 👍 or 👎 to provide feedback.
| ``` | ||
| Error: The trigger config file was not found. By default, we look for a trigger.config.ts file in the root of your repository. | ||
| ``` |
There was a problem hiding this comment.
🚩 Error message in 'Required Trigger Config' section may not match actual CLI output
The error message shown at docs/vercel-integration.mdx:103 (Error: The trigger config file was not found. By default, we look for a trigger.config.ts file in the root of your repository.) appears to be a paraphrased/fabricated error message rather than one copied from the actual CLI or build system. I was unable to find this exact string in the codebase. If a user encounters a different error message in practice, this could cause confusion. However, the general guidance is correct — a missing trigger.config.ts will cause build failures.
Was this helpful? React with 👍 or 👎 to provide feedback.
|
Closing this for now since the repository requires vouched contributors. Happy to revisit if needed. |
Closes #3511
Checklist
Testing
Changelog
Screenshots
Not applicable (documentation update only)