Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
|
![claude[bot]](https://avatars.githubusercontent.com/in/1236702?s=60&v=4){kind=small}
There was a problem hiding this comment.
PR Review Summary
(2) Total Issues | Risk: Medium
🟠⚠️ Major (1) 🟠⚠️
🟠 1) scheduled-triggers.mdx:68 Manually committed auto-generated file
Issue: The new scheduled-triggers.mdx file contains the comment "This file was generated by Fumadocs. Do not edit this file directly" but appears to have been manually added to the PR rather than being output from the generation pipeline.
Why: The canonical icon mapping in agents-docs/scripts/generate-openapi-docs.ts already defines 'Scheduled Triggers': 'LuClock' (line 46). Manually committing generated files creates maintenance risk:
- Content may be overwritten on the next generation run
- Manual edits can drift from the source of truth (OpenAPI spec)
- Creates confusion about what's generated vs hand-edited
Fix: Remove this file from the commit and run the generation command instead:
cd agents-docs && pnpm generate:openapi-docsIf this file should exist and isn't being generated automatically, that may indicate an issue with the OpenAPI spec or generation script that should be addressed first.
Refs:
Inline Comments:
- 🟠 Major:
scheduled-triggers.mdx:68Manually committed auto-generated file
🟡 Minor (1) 🟡
Inline Comments:
- 🟡 Minor:
scheduled-triggers.mdx:70Missing trailing newline
💭 Consider (2) 💭
💭 1) api-reference/(openapi)/triggers.mdx API Reference icon consistency
Issue: The API Reference triggers.mdx page retains LuWebhook while the guide/SDK equivalents (talk-to-your-agents/triggers, typescript-sdk/triggers) now use LuZap. This creates cross-surface inconsistency where the same concept has different visual representations.
Why: Users navigating between SDK docs and API reference will see a visual mismatch for "Triggers" content.
Fix: This may be intentional (API reference using LuWebhook for protocol-level docs, guides using LuZap for conceptual docs). If you want full consistency, update the TitleToIcon mapping in generate-openapi-docs.ts to use LuZap for Triggers. Otherwise, consider documenting the icon semantic distinction.
Refs:
💭 2) webhooks.mdx Semantic icon meaning
Issue: The webhook-specific pages (typescript-sdk/triggers/webhooks.mdx, talk-to-your-agents/triggers/webhooks.mdx) now use generic LuZap instead of the semantically appropriate LuWebhook. Meanwhile, the API reference webhooks.mdx still uses LuWebhook.
Why: Using LuZap (lightning bolt) for webhook pages loses the visual connection to the webhook concept. Users might expect webhook-specific content to use the webhook icon.
Fix: Consider keeping LuWebhook for webhook-specific pages to maintain semantic icon meaning, or update the API reference webhooks page to LuZap for consistency. This is a design choice about visual consistency vs semantic meaning.
🚫 REQUEST CHANGES
Summary: The icon changes are reasonable from a UX perspective, but the main blocker is the manually committed auto-generated file. The scheduled-triggers.mdx file should be generated by running pnpm generate:openapi-docs rather than committed manually — this ensures it stays in sync with the OpenAPI spec and avoids maintenance issues. Once that's addressed, the icon consistency questions in "Consider" are developer preference decisions.
Discarded (3)
| Location | Issue | Reason Discarded |
|---|---|---|
typescript-sdk/triggers/overview.mdx:5 |
LuSparkles icon inconsistent with parent LuZap |
The LuSparkles icon actually follows the established pattern for overview pages across the docs — other overview pages (MCP servers, credentials, connect-your-data) also use LuSparkles. This is consistent behavior, not an inconsistency. |
api-reference/(openapi)/webhooks.mdx |
Not updated to LuZap |
This file was not changed in the PR. The existing LuWebhook icon is appropriate for HTTP webhook endpoint documentation. |
scheduled-triggers.mdx icon choice |
LuClock appropriateness |
Noted as correct — LuClock is the established pattern for time-based/scheduled operations. No action needed. |
Reviewers (3)
| Reviewer | Returned | Main Findings | Consider | While You're Here | Inline Comments | Pending Recs | Discarded |
|---|---|---|---|---|---|---|---|
pr-review-docs |
3 | 0 | 0 | 0 | 2 | 0 | 1 |
pr-review-product |
4 | 0 | 2 | 0 | 0 | 0 | 2 |
pr-review-consistency |
7 | 1 | 0 | 0 | 0 | 0 | 6 |
| Total | 14 | 1 | 2 | 0 | 2 | 0 | 9 |
Note: Several findings were merged across reviewers addressing the same concerns (icon inconsistency, API reference divergence).
|
|
||
| {/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */} | ||
|
|
||
| <APIPage document={"index"} webhooks={[]} operations={[{"path":"/manage/tenants/{tenantId}/projects/{projectId}/agents/{agentId}/scheduled-triggers","method":"get"},{"path":"/manage/tenants/{tenantId}/projects/{projectId}/agents/{agentId}/scheduled-triggers","method":"post"},{"path":"/manage/tenants/{tenantId}/projects/{projectId}/agents/{agentId}/scheduled-triggers/upcoming-runs","method":"get"},{"path":"/manage/tenants/{tenantId}/projects/{projectId}/agents/{agentId}/scheduled-triggers/{id}","method":"get"},{"path":"/manage/tenants/{tenantId}/projects/{projectId}/agents/{agentId}/scheduled-triggers/{id}","method":"patch"},{"path":"/manage/tenants/{tenantId}/projects/{projectId}/agents/{agentId}/scheduled-triggers/{id}","method":"delete"},{"path":"/manage/tenants/{tenantId}/projects/{projectId}/agents/{agentId}/scheduled-triggers/{id}/invocations","method":"get"},{"path":"/manage/tenants/{tenantId}/projects/{projectId}/agents/{agentId}/scheduled-triggers/{id}/invocations/{invocationId}","method":"get"},{"path":"/manage/tenants/{tenantId}/projects/{projectId}/agents/{agentId}/scheduled-triggers/{id}/invocations/{invocationId}/cancel","method":"post"},{"path":"/manage/tenants/{tenantId}/projects/{projectId}/agents/{agentId}/scheduled-triggers/{id}/invocations/{invocationId}/rerun","method":"post"},{"path":"/manage/tenants/{tenantId}/projects/{projectId}/agents/{agentId}/scheduled-triggers/{id}/run","method":"post"}]} showTitle={true} /> No newline at end of file |
There was a problem hiding this comment.
🟡 Minor: Missing trailing newline
Issue: The file is missing a trailing newline at the end.
Why: While not a functional issue, this violates POSIX standards and may cause warnings in some editors or linters. It creates noise in future diffs if someone adds content.
Fix: (1-click apply)
| <APIPage document={"index"} webhooks={[]} operations={[{"path":"/manage/tenants/{tenantId}/projects/{projectId}/agents/{agentId}/scheduled-triggers","method":"get"},{"path":"/manage/tenants/{tenantId}/projects/{projectId}/agents/{agentId}/scheduled-triggers","method":"post"},{"path":"/manage/tenants/{tenantId}/projects/{projectId}/agents/{agentId}/scheduled-triggers/upcoming-runs","method":"get"},{"path":"/manage/tenants/{tenantId}/projects/{projectId}/agents/{agentId}/scheduled-triggers/{id}","method":"get"},{"path":"/manage/tenants/{tenantId}/projects/{projectId}/agents/{agentId}/scheduled-triggers/{id}","method":"patch"},{"path":"/manage/tenants/{tenantId}/projects/{projectId}/agents/{agentId}/scheduled-triggers/{id}","method":"delete"},{"path":"/manage/tenants/{tenantId}/projects/{projectId}/agents/{agentId}/scheduled-triggers/{id}/invocations","method":"get"},{"path":"/manage/tenants/{tenantId}/projects/{projectId}/agents/{agentId}/scheduled-triggers/{id}/invocations/{invocationId}","method":"get"},{"path":"/manage/tenants/{tenantId}/projects/{projectId}/agents/{agentId}/scheduled-triggers/{id}/invocations/{invocationId}/cancel","method":"post"},{"path":"/manage/tenants/{tenantId}/projects/{projectId}/agents/{agentId}/scheduled-triggers/{id}/invocations/{invocationId}/rerun","method":"post"},{"path":"/manage/tenants/{tenantId}/projects/{projectId}/agents/{agentId}/scheduled-triggers/{id}/run","method":"post"}]} showTitle={true} /> | |
| <APIPage document={"index"} webhooks={[]} operations={[{"path":"/manage/tenants/{tenantId}/projects/{projectId}/agents/{agentId}/scheduled-triggers","method":"get"},{"path":"/manage/tenants/{tenantId}/projects/{projectId}/agents/{agentId}/scheduled-triggers","method":"post"},{"path":"/manage/tenants/{tenantId}/projects/{projectId}/agents/{agentId}/scheduled-triggers/upcoming-runs","method":"get"},{"path":"/manage/tenants/{tenantId}/projects/{projectId}/agents/{agentId}/scheduled-triggers/{id}","method":"get"},{"path":"/manage/tenants/{tenantId}/projects/{projectId}/agents/{agentId}/scheduled-triggers/{id}","method":"patch"},{"path":"/manage/tenants/{tenantId}/projects/{projectId}/agents/{agentId}/scheduled-triggers/{id}","method":"delete"},{"path":"/manage/tenants/{tenantId}/projects/{projectId}/agents/{agentId}/scheduled-triggers/{id}/invocations","method":"get"},{"path":"/manage/tenants/{tenantId}/projects/{projectId}/agents/{agentId}/scheduled-triggers/{id}/invocations/{invocationId}","method":"get"},{"path":"/manage/tenants/{tenantId}/projects/{projectId}/agents/{agentId}/scheduled-triggers/{id}/invocations/{invocationId}/cancel","method":"post"},{"path":"/manage/tenants/{tenantId}/projects/{projectId}/agents/{agentId}/scheduled-triggers/{id}/invocations/{invocationId}/rerun","method":"post"},{"path":"/manage/tenants/{tenantId}/projects/{projectId}/agents/{agentId}/scheduled-triggers/{id}/run","method":"post"}]} showTitle={true} /> |
Refs:
| contents: [] | ||
| --- | ||
|
|
||
| {/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */} |
There was a problem hiding this comment.
🟠 Major: Manually committed auto-generated file
Issue: This file contains the comment "This file was generated by Fumadocs. Do not edit this file directly" but appears to have been manually added to the PR.
Why: The canonical icon mapping in agents-docs/scripts/generate-openapi-docs.ts already defines 'Scheduled Triggers': 'LuClock' (line 46). Manually committing generated files risks:
- Content being overwritten on the next generation run
- Manual edits drifting from the source of truth
- Maintenance confusion about what's generated vs hand-edited
Fix: Consider removing this file from the commit and running the generation command instead:
cd agents-docs && pnpm generate:openapi-docsIf this file should exist and isn't being generated, that may indicate a separate issue with the OpenAPI generation process.
Refs:
There was a problem hiding this comment.
@dimaMachina @anubra266 Are these files supposed to be committed or not?
There was a problem hiding this comment.
we are committing these files for now
3 participants
No description provided.