Skip to content

Add cname flattening docs#2745

Merged
adityaoberai merged 8 commits intomainfrom
add-cname-flattening-docs
Feb 26, 2026
Merged

Add cname flattening docs#2745
adityaoberai merged 8 commits intomainfrom
add-cname-flattening-docs

Conversation

@adityaoberai
Copy link
Member

@adityaoberai adityaoberai commented Feb 11, 2026

What does this PR do?

Adds docs to explain how to add apex domains with CNAME flattening

Test Plan

Visit /docs/products/sites/domains

Related PRs and Issues

No

Have you read the Contributing Guidelines on issues?

Yes

Summary by CodeRabbit

  • Documentation

    • Clarified apex domain setup by splitting NS-record and CNAME-flattening methods, added step-by-step guidance, rationale, DNS examples (CNAME/ALIAS/ANAME, CAA), propagation notes, and updated TLS guidance to reflect deployment-specific certificate authorities and explicit TLS coverage for Sites domains. Added accompanying light/dark visuals for both flows.
  • Chores

    • Added four new image assets to the optimize cache for the updated doc visuals.

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Feb 11, 2026

Note

Reviews paused

It looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the reviews.auto_review.auto_pause_after_reviewed_commits setting.

Use the following commands to manage reviews:

  • @coderabbitai resume to resume automatic reviews.
  • @coderabbitai review to trigger a single review.

Use the checkboxes below for quick actions:

  • ▶️ Resume reviews
  • 🔍 Trigger review

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 2b35f1f and 7fefb2f.

📒 Files selected for processing (2)
  • .optimize-cache.json
  • src/routes/docs/products/network/dns/+page.markdoc
🚧 Files skipped from review as they are similar to previous changes (2)
  • .optimize-cache.json
  • src/routes/docs/products/network/dns/+page.markdoc

Walkthrough

Adds four image assets to the optimize cache (light and dark variants for add-domain-cname and add-domain-ns). Updates documentation: Sites domains page now presents two apex-domain approaches (NS records and CNAME-flattening/ALIAS/ANAME) with new images and propagation notes; DNS docs reorganized similarly to include NS delegation and CNAME-flattening workflows; TLS docs revised to describe deployment-specific certificate authorities (self-hosted: Let's Encrypt; Appwrite Cloud: Certainly) and explicitly list Domains for Appwrite Sites.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title 'Add cname flattening docs' accurately describes the primary change—adding documentation about CNAME flattening as an alternative method for apex domains.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch add-cname-flattening-docs

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🤖 Fix all issues with AI agents
In `@src/routes/docs/products/sites/domains/`+page.markdoc:
- Line 96: The CAA record example currently shows the wrong CA; locate the line
containing the CAA example string '0 issue "certainly.com"' (the list item that
starts "Copy the **CAA** record") and change its value to Let's Encrypt by
replacing '0 issue "certainly.com"' with '0 issue "letsencrypt.org"'; ensure the
surrounding markup and emphasis (the "**CAA** record" list item) remain
unchanged.
🧹 Nitpick comments (1)
src/routes/docs/products/sites/domains/+page.markdoc (1)

91-100: Steps 5 and 8 overlap; consider consolidating.

Step 5 says to copy the CNAME record (appwrite.network), and step 8 says to "point the record to the Appwrite hostname provided in the console." These describe the same target value but are split across two steps, which may confuse readers. Consider merging them so step 7 reads something like: "Create an ALIAS/ANAME/CNAME record at the apex pointed to appwrite.network" and remove step 8.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 2

🤖 Fix all issues with AI agents
In `@src/routes/docs/products/network/dns/`+page.markdoc:
- Line 86: The sentence "Add the CAA record to your DNS provider's settings,
also pointed at the apex" is ambiguous; replace it with a clearer phrasing such
as "Add the CAA record at the apex level in your DNS provider's settings" so it
doesn't imply the CAA record "points" to anything — update the line containing
that exact string in src/routes/docs/products/network/dns/+page.markdoc
accordingly.
- Around line 92-94: The heading "Adding records in Appwrite" (anchor
`#adding-records`) currently implies NS delegation; update the text to explicitly
scope this section to the nameserver (NS) delegation path and avoid implying
it's required for all setups — e.g., change the sentence that begins "After
delegating your domain to Appwrite's DNS servers" to clarify "If you delegated
your domain to Appwrite's nameservers (NS records), then..." and add a brief
note that users who used CNAME flattening or other apex methods do not need to
delegate nameservers and should follow the alternative CNAME/flattening
instructions instead.

@adityaoberai adityaoberai merged commit df096f7 into main Feb 26, 2026
6 checks passed
@adityaoberai adityaoberai deleted the add-cname-flattening-docs branch February 26, 2026 21:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants