update to use appwrite.run and appwrite.network domains for functions#2769
update to use appwrite.run and appwrite.network domains for functions#2769atharvadeosthale merged 3 commits intomainfrom
Conversation
WalkthroughThis pull request updates documentation examples and content to use region-specific appwrite.run domains (e.g., https://.fra.appwrite.run) instead of appwrite.global, expands the Functions domains page with generated region domains and an appwrite.network edge domain option, adds a step-by-step custom domain workflow, updates execute and webhook example URLs, and removes an Availability info block from the network endpoints page. No application code or runtime logic changes are present. Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 minutes 🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ 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. Comment |
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (1)
src/routes/docs/products/functions/domains/+page.markdoc (1)
8-10: Minor wording redundancy.
HTTP methodsappears twice in close proximity — once as the execution mechanism and again inside the comma-separated list on Line 9. Consider removing the second instance to avoid repetition, e.g.:✏️ Suggested wording
-You can use this domain to execute Appwrite Functions through HTTP methods. -You can use common practices like using paths, query parameters, headers, HTTP methods, formdata, +You can use this domain to execute Appwrite Functions via HTTP. +You can use common practices like paths, query parameters, headers, formdata, and all the typical HTTP concepts to implement Appwrite Functions.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@src/routes/docs/products/functions/domains/`+page.markdoc around lines 8 - 10, The first sentence ("You can use this domain to execute Appwrite Functions through HTTP methods.") duplicates the phrase "HTTP methods" that also appears in the following sentence; edit the second sentence (the one starting "You can use common practices like using paths, query parameters, headers, HTTP methods, formdata, and all the typical HTTP concepts...") to remove the repeated "HTTP methods" from the comma-separated list (e.g., keep "paths, query parameters, headers, formdata, and all the typical HTTP concepts") so the wording is concise and non-redundant.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@src/routes/docs/products/functions/domains/`+page.markdoc:
- Around line 42-46: Clarify that the Console assigns an Appwrite-managed
subdomain (not that the user types "appwrite.network") by updating the step that
currently reads "Click on **Create domain** and add the `appwrite.network`
domain to your function" — change it to explicitly state that after clicking
"Create domain" in the **Domains** tab the Console will provision an
Appwrite-managed subdomain in the form `<function-id>.appwrite.network` (or
similar), and separately note that if you want a custom domain you must use the
"Input your domain"/custom domain flow; reference the strings "Create domain",
"Domains" tab, and `appwrite.network` when making the wording change so the
intent is unambiguous.
---
Nitpick comments:
In `@src/routes/docs/products/functions/domains/`+page.markdoc:
- Around line 8-10: The first sentence ("You can use this domain to execute
Appwrite Functions through HTTP methods.") duplicates the phrase "HTTP methods"
that also appears in the following sentence; edit the second sentence (the one
starting "You can use common practices like using paths, query parameters,
headers, HTTP methods, formdata, and all the typical HTTP concepts...") to
remove the repeated "HTTP methods" from the comma-separated list (e.g., keep
"paths, query parameters, headers, formdata, and all the typical HTTP concepts")
so the wording is concise and non-redundant.
ℹ️ Review info
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (5)
src/routes/docs/products/functions/develop/+page.markdocsrc/routes/docs/products/functions/domains/+page.markdocsrc/routes/docs/products/functions/execute/+page.markdocsrc/routes/docs/products/network/endpoints/+page.markdocsrc/routes/docs/tutorials/subscriptions-with-stripe/step-4/+page.markdoc
💤 Files with no reviewable changes (1)
- src/routes/docs/products/network/endpoints/+page.markdoc
| To add an edge network domain: | ||
|
|
||
| 1. Navigate to the Appwrite Console's **Functions** page. | ||
| 2. Navigate to the **Domains** tab. | ||
| 3. Click on **Create domain** and add the `appwrite.network` domain to your function. |
There was a problem hiding this comment.
Ambiguous setup instructions for appwrite.network domain.
The current step:
"Click on Create domain and add the
appwrite.networkdomain to your function."
…does not clarify whether the user is typing appwrite.network as their domain, or whether the system auto-assigns a <ID>.appwrite.network subdomain after clicking a button. The custom domain section explicitly says "Input your domain," so readers will likely expect the same here — but appwrite.network is not a user-owned domain.
Consider making the UX action explicit, e.g., something like:
✏️ Suggested wording
-1. Navigate to the Appwrite Console's **Functions** page.
-2. Navigate to the **Domains** tab.
-3. Click on **Create domain** and add the `appwrite.network` domain to your function.
+1. Navigate to the Appwrite Console's **Functions** page.
+2. Navigate to the **Domains** tab.
+3. Click **Add edge domain** (or **Create domain** → select **Edge network**) to assign an `appwrite.network` domain to your function.(Adjust button names to match the actual Console UI.)
📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| To add an edge network domain: | |
| 1. Navigate to the Appwrite Console's **Functions** page. | |
| 2. Navigate to the **Domains** tab. | |
| 3. Click on **Create domain** and add the `appwrite.network` domain to your function. | |
| To add an edge network domain: | |
| 1. Navigate to the Appwrite Console's **Functions** page. | |
| 2. Navigate to the **Domains** tab. | |
| 3. Click **Add edge domain** (or **Create domain** → select **Edge network**) to assign an `appwrite.network` domain to your function. |
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@src/routes/docs/products/functions/domains/`+page.markdoc around lines 42 -
46, Clarify that the Console assigns an Appwrite-managed subdomain (not that the
user types "appwrite.network") by updating the step that currently reads "Click
on **Create domain** and add the `appwrite.network` domain to your function" —
change it to explicitly state that after clicking "Create domain" in the
**Domains** tab the Console will provision an Appwrite-managed subdomain in the
form `<function-id>.appwrite.network` (or similar), and separately note that if
you want a custom domain you must use the "Input your domain"/custom domain
flow; reference the strings "Create domain", "Domains" tab, and
`appwrite.network` when making the wording change so the intent is unambiguous.
There was a problem hiding this comment.
♻️ Duplicate comments (1)
src/routes/docs/products/functions/domains/+page.markdoc (1)
44-46:⚠️ Potential issue | 🟡 MinorAmbiguous setup instructions for the
appwrite.networkdomain (still unresolved).Step 3 — "Click on Create domain and add the
appwrite.networkdomain to your function" — does not clarify whether the user manually typesappwrite.networkas their domain or whether the Console auto-provisions a subdomain (e.g.,<ID>.appwrite.network) after clicking a button. Since the custom domain section explicitly asks the user to "Input your domain," readers will likely try to typeappwrite.networkliterally, which is not a user-owned domain.Consider making the actual Console UX action explicit:
✏️ Suggested wording
-1. Navigate to the Appwrite Console's **Functions** page. -2. Navigate to the **Domains** tab. -3. Click on **Create domain** and add the `appwrite.network` domain to your function. +1. Navigate to the Appwrite Console's **Functions** page. +2. Navigate to the **Domains** tab. +3. Click **Create domain**, then select **Edge network** to let Appwrite assign + an `<ID>.appwrite.network` subdomain to your function automatically.Adjust button/option labels to match the actual Console UI.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@src/routes/docs/products/functions/domains/`+page.markdoc around lines 44 - 46, The step "Click on **Create domain** and add the `appwrite.network` domain to your function" is ambiguous; update the text in +page.markdoc so it explicitly explains the Console UX (whether the user types a domain or the Console provisions a subdomain), use the exact Console button/option labels, and show the correct example (e.g., "enter your custom domain" vs "select 'Provision appwrite.network subdomain' to get <ID>.appwrite.network"); replace the current Step 3 line with a clear instruction that matches the UI, mention the resulting hostname format (if auto-provisioned) or state to not literally enter "appwrite.network", and ensure the wording matches the Domains tab and Create domain button labels used in the Console.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Duplicate comments:
In `@src/routes/docs/products/functions/domains/`+page.markdoc:
- Around line 44-46: The step "Click on **Create domain** and add the
`appwrite.network` domain to your function" is ambiguous; update the text in
+page.markdoc so it explicitly explains the Console UX (whether the user types a
domain or the Console provisions a subdomain), use the exact Console
button/option labels, and show the correct example (e.g., "enter your custom
domain" vs "select 'Provision appwrite.network subdomain' to get
<ID>.appwrite.network"); replace the current Step 3 line with a clear
instruction that matches the UI, mention the resulting hostname format (if
auto-provisioned) or state to not literally enter "appwrite.network", and ensure
the wording matches the Domains tab and Create domain button labels used in the
Console.
There was a problem hiding this comment.
Actionable comments posted: 1
♻️ Duplicate comments (1)
src/routes/docs/products/functions/domains/+page.markdoc (1)
38-40:⚠️ Potential issue | 🟡 MinorClarify that Console assigns an Appwrite-managed
*.appwrite.networksubdomain.Line 40 still reads like users should manually enter
appwrite.network. This ambiguity was already raised and appears unresolved.✏️ Suggested wording
-3. Click on **Create domain** and add the `appwrite.network` domain to your function. +3. Click on **Create domain** and select the edge network option to assign an Appwrite-managed `*.appwrite.network` subdomain to your function.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@src/routes/docs/products/functions/domains/`+page.markdoc around lines 38 - 40, The instruction "Click on **Create domain** and add the `appwrite.network` domain to your function." is ambiguous; change the step to clarify that the Console automatically assigns an Appwrite-managed subdomain (a *.appwrite.network address) to your function rather than asking users to enter "appwrite.network" themselves—e.g., update the text in the step that currently reads "Click on **Create domain** and add the `appwrite.network` domain to your function." to something like "Click **Create domain** — the Console will assign an Appwrite-managed subdomain (for example, <your-function>.appwrite.network) to your function" so users understand the subdomain is provided by Console.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@src/routes/docs/products/functions/domains/`+page.markdoc:
- Around line 9-10: The sentence in the docs duplicates "HTTP methods" and uses
the incorrect token `formdata`; edit the sentence to remove the repeated phrase
and change `formdata` to "form data" so it reads e.g. "You can use common
practices like using paths, query parameters, headers, HTTP methods, form data,
and other typical HTTP concepts to implement Appwrite Functions." Locate and
update the sentence that contains "HTTP methods" and "`formdata`" in
+page.markdoc to fix the duplication and formatting.
---
Duplicate comments:
In `@src/routes/docs/products/functions/domains/`+page.markdoc:
- Around line 38-40: The instruction "Click on **Create domain** and add the
`appwrite.network` domain to your function." is ambiguous; change the step to
clarify that the Console automatically assigns an Appwrite-managed subdomain (a
*.appwrite.network address) to your function rather than asking users to enter
"appwrite.network" themselves—e.g., update the text in the step that currently
reads "Click on **Create domain** and add the `appwrite.network` domain to your
function." to something like "Click **Create domain** — the Console will assign
an Appwrite-managed subdomain (for example, <your-function>.appwrite.network) to
your function" so users understand the subdomain is provided by Console.
| You can use common practices like using paths, query parameters, headers, HTTP methods, formdata, | ||
| and all the typical HTTP concepts to implement Appwrite Functions. |
There was a problem hiding this comment.
Fix duplicated wording and formdata formatting in the HTTP concepts sentence.
Line 9 repeats “HTTP methods” and uses formdata instead of “form data”, which hurts doc clarity.
✏️ Suggested edit
-You can use common practices like using paths, query parameters, headers, HTTP methods, formdata,
-and all the typical HTTP concepts to implement Appwrite Functions.
+You can use common practices like paths, query parameters, headers, HTTP methods, form data,
+and other standard HTTP concepts to implement Appwrite Functions.📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| You can use common practices like using paths, query parameters, headers, HTTP methods, formdata, | |
| and all the typical HTTP concepts to implement Appwrite Functions. | |
| You can use common practices like paths, query parameters, headers, HTTP methods, form data, | |
| and other standard HTTP concepts to implement Appwrite Functions. |
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@src/routes/docs/products/functions/domains/`+page.markdoc around lines 9 -
10, The sentence in the docs duplicates "HTTP methods" and uses the incorrect
token `formdata`; edit the sentence to remove the repeated phrase and change
`formdata` to "form data" so it reads e.g. "You can use common practices like
using paths, query parameters, headers, HTTP methods, form data, and other
typical HTTP concepts to implement Appwrite Functions." Locate and update the
sentence that contains "HTTP methods" and "`formdata`" in +page.markdoc to fix
the duplication and formatting.
Summary by CodeRabbit