Docs/various docs improvements #1716
Conversation
|
WalkthroughThis pull request updates several documentation files. In the configuration docs, the Prisma build extension description has been refined and new build extensions (e.g., Changes
Sequence Diagram(s)sequenceDiagram
participant C as Client
participant S as Server
participant DB as TTL Store
C->>S: Trigger task with idempotencyKey & idempotencyKeyTTL ("5m")
S->>DB: Check if idempotencyKey exists & is active
alt Key exists and TTL active
DB-->>S: Return existing task run record
S-->>C: Return existing task run
else Key absent or expired
S->>DB: Record new idempotencyKey with TTL
S->>C: Initiate new task run
end
Possibly related PRs
Suggested reviewers
Poem
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
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)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (4)
docs/idempotency.mdx (1)
104-106: Grammar Suggestion: Add a Comma After “By default”
On the sentence “By default idempotency keys are stored for 30 days…”, consider inserting a comma after “By default” for improved readability.-By default idempotency keys are stored for 30 days. +By default, idempotency keys are stored for 30 days.🧰 Tools
🪛 LanguageTool
[uncategorized] ~104-~104: Did you mean: “By default,”?
Context: ...-ttl](/images/idempotency-key-ttl.png) By default idempotency keys are stored for 30 days...(BY_DEFAULT_COMMA)
docs/runs.mdx (1)
136-139: Enhanced TTL Explanation for Runs
The revised TTL segment clearly explains that a run will expire (returning theExpiredstatus) if it cannot start within the specified timeframe. The added note about dev versus staging/production environments is especially useful. Consider separating the explanation and the environment note into distinct paragraphs for even greater clarity.docs/config/config-file.mdx (2)
400-405: Prisma Extension Updates & Grammar Improvements
The updated Prisma extension section now covers multiple aspects—copying files, client generation, migration, and support for multiple schemas. However, note the following suggestions:
- In lines 401–402, the phrase “during the deploy process” is used. Consider changing “deploy” to “deployment” to use a noun form consistently (e.g. “generates the Prisma client during the deployment process” and “optionally migrates the database during the deployment process”).
- Additionally, review verb tense consistency; for example, “Optionally will migrate…” might be revised to “Optionally migrates…”.
An example diff for line 402:- Optionally will migrate the database during the deploy process + Optionally migrates the database during the deployment process🧰 Tools
🪛 LanguageTool
[grammar] ~401-~401: The word ‘deploy’ is a verb. Did you mean the noun “deployment” (= release, placement)?
Context: ... Generates the Prisma client during the deploy process - Optionally will migrate the d...(PREPOSITION_VERB)
[grammar] ~402-~402: The word ‘deploy’ is a verb. Did you mean the noun “deployment” (= release, placement)?
Context: ...ly will migrate the database during the deploy process - Support for TypedSQL and mult...(PREPOSITION_VERB)
527-527: Punctuation Suggestion for Clarity
In the sentence “If you have multiple separate schemas in the same project you can add the extension multiple times:”, consider adding a comma after “project” to improve readability.-If you have multiple separate schemas in the same project you can add the extension multiple times: +If you have multiple separate schemas in the same project, you can add the extension multiple times:🧰 Tools
🪛 LanguageTool
[uncategorized] ~527-~527: Possible missing comma found.
Context: ...e multiple separate schemas in the same project you can add the extension multiple time...(AI_HYDRA_LEO_MISSING_COMMA)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (1)
docs/images/idempotency-key-ttl.pngis excluded by!**/*.png
📒 Files selected for processing (5)
docs/config/config-file.mdx(2 hunks)docs/idempotency.mdx(1 hunks)docs/limits.mdx(1 hunks)docs/runs.mdx(1 hunks)docs/troubleshooting-alerts.mdx(1 hunks)
🧰 Additional context used
🪛 LanguageTool
docs/idempotency.mdx
[uncategorized] ~104-~104: Did you mean: “By default,”?
Context: ...-ttl](/images/idempotency-key-ttl.png) By default idempotency keys are stored for 30 days...
(BY_DEFAULT_COMMA)
docs/config/config-file.mdx
[grammar] ~401-~401: The word ‘deploy’ is a verb. Did you mean the noun “deployment” (= release, placement)?
Context: ... Generates the Prisma client during the deploy process - Optionally will migrate the d...
(PREPOSITION_VERB)
[grammar] ~402-~402: The word ‘deploy’ is a verb. Did you mean the noun “deployment” (= release, placement)?
Context: ...ly will migrate the database during the deploy process - Support for TypedSQL and mult...
(PREPOSITION_VERB)
[uncategorized] ~527-~527: Possible missing comma found.
Context: ...e multiple separate schemas in the same project you can add the extension multiple time...
(AI_HYDRA_LEO_MISSING_COMMA)
⏰ Context from checks skipped due to timeout of 90000ms (1)
- GitHub Check: Analyze (javascript-typescript)
🔇 Additional comments (8)
docs/limits.mdx (1)
116-118: Clarify Alert Destinations Flexibility
The updated text now emphasizes that Pro plan customers can request more than their plan limit rather than being capped at a hard number. This makes the messaging more flexible and customer-friendly.docs/idempotency.mdx (1)
97-104: Introduce and ExplainidempotencyKeyTTLOption
The new section clearly explains how theidempotencyKeyTTLoption works by outlining the time window behavior and including a supporting diagram. This addition improves the documentation on idempotency.🧰 Tools
🪛 LanguageTool
[uncategorized] ~104-~104: Did you mean: “By default,”?
Context: ...-ttl](/images/idempotency-key-ttl.png) By default idempotency keys are stored for 30 days...(BY_DEFAULT_COMMA)
docs/troubleshooting-alerts.mdx (1)
97-105: Addition of “Common properties” Section is Clear
The new “Common properties” section organizes shared webhook payload attributes in a user-friendly manner. It complements other alert documentation sections well and aids in setting proper expectations for webhook consumers.docs/config/config-file.mdx (5)
542-556: New Build Extensions:syncEnvVarsandsyncVercelEnvVars
The introduction of the new build extensions (syncEnvVars,syncVercelEnvVars, etc.) is well documented with clear examples. This improves the configuration experience by replacing deprecated features and guiding users on required environment variables and usage examples.
585-599: New Build Extension:audioWaveform
The addition of theaudioWaveformbuild extension now explicitly documents its default version and usage. This section is clear and provides a good reference for users needing audio processing support.
601-618: Puppeteer Extension Documentation is Comprehensive
The Puppeteer section includes a clear note on system requirements (e.g. setting thePUPPETEER_EXECUTABLE_PATH) and links to further guides. This addition is helpful for projects requiring headless browser functionality.
628-658: FFmpeg Extension Clarifications
The FFmpeg extension section clearly documents both the default behavior and how to specify a version. The explanation about how the extension injects environment variables is concise and useful.
664-690: Esbuild Plugins and Custom Extensions Sections
These sections provide detailed examples on integrating third-party esbuild plugins and writing custom build extensions. The examples, notes, and references to further documentation enhance the overall clarity of the build configuration documentation.
Summary by CodeRabbit