docs: fix configuration links and add sites card#2820
docs: fix configuration links and add sites card#2820AdithRavi wants to merge 1 commit intoappwrite:mainfrom
Conversation
WalkthroughUpdated internal navigation links in the self-hosting documentation page. The "Configure services" step now references email and storage using a local anchor ( Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
📝 Coding Plan
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 Tip You can customize the tone of the review comments and chat replies.Configure the |
![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
🤖 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/advanced/self-hosting/`+page.markdoc:
- Around line 136-138: The cards_item block with title "Appwrite Sites"
currently uses href="/docs/products/sites"; update that href to point to the
self-hosting configuration page (e.g.,
"/docs/advanced/self-hosting/configuration/sites") so the link is consistent
with the surrounding self-hosting configuration links — locate the {% cards_item
href="..." title="Appwrite Sites" %} block and replace the href value
accordingly.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: cd2aeec7-d77d-4c47-b63c-bf0576f06ad2
📒 Files selected for processing (1)
src/routes/docs/advanced/self-hosting/+page.markdoc
| {% cards_item href="/docs/products/sites" title="Appwrite Sites" %} | ||
| Deploy and manage your web apps with ease using Appwrite's hosting solution. | ||
| {% /cards_item %} |
There was a problem hiding this comment.
Appwrite Sites card target is inconsistent with the surrounding self-hosting configuration links.
On Line 136, href="/docs/products/sites" points to product docs, while this grid is specifically self-hosting configuration. Consider linking to the self-hosting sites configuration page (for example, /docs/advanced/self-hosting/configuration/sites) for consistency and task relevance.
Suggested patch
-{% cards_item href="/docs/products/sites" title="Appwrite Sites" %}
+{% cards_item href="/docs/advanced/self-hosting/configuration/sites" title="Appwrite Sites" %}
Deploy and manage your web apps with ease using Appwrite's hosting solution.
{% /cards_item %}📝 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.
| {% cards_item href="/docs/products/sites" title="Appwrite Sites" %} | |
| Deploy and manage your web apps with ease using Appwrite's hosting solution. | |
| {% /cards_item %} | |
| {% cards_item href="/docs/advanced/self-hosting/configuration/sites" title="Appwrite Sites" %} | |
| Deploy and manage your web apps with ease using Appwrite's hosting solution. | |
| {% /cards_item %} |
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@src/routes/docs/advanced/self-hosting/`+page.markdoc around lines 136 - 138,
The cards_item block with title "Appwrite Sites" currently uses
href="/docs/products/sites"; update that href to point to the self-hosting
configuration page (e.g., "/docs/advanced/self-hosting/configuration/sites") so
the link is consistent with the surrounding self-hosting configuration links —
locate the {% cards_item href="..." title="Appwrite Sites" %} block and replace
the href value accordingly.
Greptile SummaryThis PR intends to fix broken documentation links in the Self-Hosting configuration section and add an "Appwrite Sites" card to the configuration grid. However, the core premise of the fix is incorrect — the dedicated configuration sub-pages the original links pointed to (
Confidence Score: 1/5
Important Files Changed
Last reviewed commit: "Update links for con..." |
![greptile-apps[bot]](https://avatars.githubusercontent.com/in/867647?s=60&v=4){kind=small}
| 1. **Use a one-click deployment** - Choose from [marketplace installations](#one-click-deployments) for instant setup | ||
| 2. **Or follow the manual installation** - Use our [Docker installation guide](/docs/advanced/self-hosting/installation) for custom setups | ||
| 3. **Configure services** - Set up [email](/docs/advanced/self-hosting/configuration/email), [storage](/docs/advanced/self-hosting/configuration/storage), and other services | ||
| 3. **Configure services** - Set up [email](/docs/advanced/self-hosting#configuration), [storage](/docs/advanced/self-hosting#configuration), and other services |
There was a problem hiding this comment.
The PR replaces specific, meaningful links with a generic #configuration anchor, but the dedicated sub-pages actually exist and have full content:
/docs/advanced/self-hosting/configuration/email→src/routes/docs/advanced/self-hosting/configuration/email/+page.markdoc✅ exists/docs/advanced/self-hosting/configuration/sms→src/routes/docs/advanced/self-hosting/configuration/sms/+page.markdoc✅ exists/docs/advanced/self-hosting/configuration/storage→src/routes/docs/advanced/self-hosting/configuration/storage/+page.markdoc✅ exists
The original links were correct. Pointing all three to #configuration degrades the user experience by dropping them at a section overview instead of directly onto the relevant configuration guide. Note that the Functions Runtime card still correctly links to its own dedicated page (/docs/advanced/self-hosting/configuration/functions) — these three cards should follow the same pattern.
| 3. **Configure services** - Set up [email](/docs/advanced/self-hosting#configuration), [storage](/docs/advanced/self-hosting#configuration), and other services | |
| 3. **Configure services** - Set up [email](/docs/advanced/self-hosting/configuration/email), [storage](/docs/advanced/self-hosting/configuration/storage), and other services |
| {% cards_item href="/docs/advanced/self-hosting#configuration" title="Email delivery" %} | ||
| Set up SMTP providers for user verification, password recovery, and notifications. | ||
| {% /cards_item %} | ||
|
|
||
| {% cards_item href="/docs/advanced/self-hosting/configuration/sms" title="SMS Delivery" %} | ||
| {% cards_item href="/docs/advanced/self-hosting#configuration" title="SMS Delivery" %} | ||
| Configure SMS providers for phone authentication and two-factor authentication. | ||
| {% /cards_item %} | ||
|
|
||
| {% cards_item href="/docs/advanced/self-hosting/configuration/storage" title="Storage Backends" %} | ||
| {% cards_item href="/docs/advanced/self-hosting#configuration" title="Storage Backends" %} | ||
| Connect external storage providers like AWS S3, Backblaze, or Wasabi. | ||
| {% /cards_item %} |
There was a problem hiding this comment.
The three cards below were changed to point to #configuration (the current page's own section heading), but their dedicated configuration pages still exist and contain comprehensive content. Users clicking any of these cards will land at the top-level configuration section rather than the specific guide they need.
The correct links should be restored:
| {% cards_item href="/docs/advanced/self-hosting#configuration" title="Email delivery" %} | |
| Set up SMTP providers for user verification, password recovery, and notifications. | |
| {% /cards_item %} | |
| {% cards_item href="/docs/advanced/self-hosting/configuration/sms" title="SMS Delivery" %} | |
| {% cards_item href="/docs/advanced/self-hosting#configuration" title="SMS Delivery" %} | |
| Configure SMS providers for phone authentication and two-factor authentication. | |
| {% /cards_item %} | |
| {% cards_item href="/docs/advanced/self-hosting/configuration/storage" title="Storage Backends" %} | |
| {% cards_item href="/docs/advanced/self-hosting#configuration" title="Storage Backends" %} | |
| Connect external storage providers like AWS S3, Backblaze, or Wasabi. | |
| {% /cards_item %} | |
| {% cards_item href="/docs/advanced/self-hosting/configuration/email" title="Email delivery" %} | |
| Set up SMTP providers for user verification, password recovery, and notifications. | |
| {% /cards_item %} | |
| {% cards_item href="/docs/advanced/self-hosting/configuration/sms" title="SMS Delivery" %} | |
| Configure SMS providers for phone authentication and two-factor authentication. | |
| {% /cards_item %} | |
| {% cards_item href="/docs/advanced/self-hosting/configuration/storage" title="Storage Backends" %} | |
| Connect external storage providers like AWS S3, Backblaze, or Wasabi. | |
| {% /cards_item %} |
| {% cards_item href="/docs/products/sites" title="Appwrite Sites" %} | ||
| Deploy and manage your web apps with ease using Appwrite's hosting solution. | ||
| {% /cards_item %} |
There was a problem hiding this comment.
The new card is in the "Configuration" section alongside cards for email, SMS, storage, and functions — all of which link to pages under /docs/advanced/self-hosting/configuration/. A dedicated self-hosting configuration page for Sites already exists at src/routes/docs/advanced/self-hosting/configuration/sites/+page.markdoc, which covers configuring Sites runtimes in a self-hosted instance.
Linking to /docs/products/sites (the general product marketing page) is inconsistent with the other cards in this section and may mislead self-hosting users who need deployment/configuration instructions.
| {% cards_item href="/docs/products/sites" title="Appwrite Sites" %} | |
| Deploy and manage your web apps with ease using Appwrite's hosting solution. | |
| {% /cards_item %} | |
| {% cards_item href="/docs/advanced/self-hosting/configuration/sites" title="Appwrite Sites" %} | |
| Deploy and manage your web apps with ease using Appwrite's hosting solution. | |
| {% /cards_item %} |
1 participant
What does this PR do?
This PR fixes broken documentation links in the Self-Hosting section. The links previously pointed to a separate configuration page that no longer exists; they now point to the
#configurationheading on the same page. Additionally, I added the "Appwrite Sites" card to the configuration grid.Test Plan
I manually verified the markdown links and ensured the
cards_itemsyntax matches the existing structure of the documentation.Related PRs and Issues
Fixes #2498
Have you read the Contributing Guidelines on issues?
Yes.
Summary by CodeRabbit