Skip to content

docs: fix configuration links and add sites card #2820

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
AdithRavi wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: fix configuration links and add sites card #2820

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 7 additions & 4 deletions src/routes/docs/advanced/self-hosting/+page.markdoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ The fastest way to get started with Appwrite self-hosting:

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
Copy link
Copy Markdown
Contributor

@greptile-apps greptile-apps bot Mar 19, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Existing dedicated pages replaced with generic anchor

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.

Suggested change
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


# Deployment options {% #deployment-options %}

Expand Down Expand Up @@ -118,21 +118,24 @@ Open-source platform for easy self-hosting with one-click deployments.
After deployment, configure Appwrite to enable additional features:

{% cards %}
{% cards_item href="/docs/advanced/self-hosting/configuration/email" title="Email delivery" %}
{% 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 %}
Comment on lines +121 to 131
Copy link
Copy Markdown
Contributor

@greptile-apps greptile-apps bot Mar 19, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Configuration cards link to generic anchor instead of dedicated pages

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:

Suggested change
{% 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/advanced/self-hosting/configuration/functions" title="Functions Runtime" %}
Enable serverless functions with custom runtimes and execution environments.
{% /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 %}
Comment on lines +136 to +138
Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai bot Mar 19, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟠 Major

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.

Suggested change
{% 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.

Comment on lines +136 to +138
Copy link
Copy Markdown
Contributor

@greptile-apps greptile-apps bot Mar 19, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Sites card should link to self-hosting configuration page

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.

Suggested change
{% 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 %}

{% /cards %}

# Production readiness {% #production-readiness %}
Expand Down