update: custom domain setup guide#732
Conversation
WalkthroughThis PR updates the custom domain guide with revised metadata, a step-by-step setup workflow, advanced DNS and social sign-in instructions, multi-level subdomain guidance, and expanded troubleshooting and FAQ content. ChangesCustom Domain Setup Guide
Estimated code review effort: 2 (Simple) | ~10 minutes Suggested reviewers: Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ 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 |
Deploying kinde-docs-preview with
|
| Latest commit: |
91c4309
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://91cb4885.kinde-docs-preview.pages.dev |
| Branch Preview URL: | https://tamal-update-add-custom-doma.kinde-docs-preview.pages.dev |
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@src/content/docs/build/domains/pointing-your-domain.mdx`:
- Around line 146-154: The two instructional screenshots currently use empty alt
attributes which makes them inaccessible; update the <img> elements that
reference the URLs ending with "9247cb87-9e7a-4977-b3f5-6c8b52f64200/public"
(and the other image at lines around the same block) to provide short
descriptive alt text that conveys the screenshot purpose (e.g., "DNS settings in
provider dashboard" or "Add CNAME record dialog") instead of alt=""; keep other
attributes (width, loading, decoding) unchanged.
- Around line 198-201: The CNAME example entry uses an incorrect
self-referential Value (`account.example.com`) that contradicts the earlier
“Value from Kinde” instruction; update the CNAME Value example in the block that
lists Host: `account` and Record type: `CNAME` to show the Kinde-provided target
(e.g., replace `account.example.com` with a clear placeholder like “Value from
Kinde” or the provider target example such as `your-tenant.kinde.com`) so
readers are guided to use the actual target shown in Kinde rather than pointing
to their own domain.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Repository UI
Review profile: CHILL
Plan: Pro
Run ID: e29c2708-edb1-4ef9-bbf6-122640c52abf
📒 Files selected for processing (1)
src/content/docs/build/domains/pointing-your-domain.mdx
There was a problem hiding this comment.
Actionable comments posted: 1
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (2)
src/content/docs/build/domains/pointing-your-domain.mdx (2)
142-142: 📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick winFix remaining hyphenation issues.
The PR objectives state hyphenation is being fixed, but two cases remain:
- Line 142: "social sign in" should be "social sign-in" (compound noun). The body text at line 144 already uses the correct "sign-in form."
- Line 176: "DNS set up" should be "DNS setup" (noun form). "Set up" is the verb form; "setup" is the noun.
✏️ Proposed fixes
-### Add the custom domain to social sign in +### Add the custom domain to social sign-in-### Tips for the DNS set up +### Tips for the DNS setupAlso applies to: 176-176
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@src/content/docs/build/domains/pointing-your-domain.mdx` at line 142, Update the headings in the domain documentation to use the correct noun hyphenation: change “social sign in” to “social sign-in” and “DNS set up” to “DNS setup.”
98-100: 📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick winCapitalize brand names correctly.
"Godaddy" should be "GoDaddy" and "NameCheap" should be "Namecheap" per each company's official brand styling.
✏️ Proposed fix
- - [Godaddy](https://au.godaddy.com/help/add-a-cname-record-19236) + - [GoDaddy](https://au.godaddy.com/help/add-a-cname-record-19236) - [Cloudflare](https://developers.cloudflare.com/dns/manage-dns-records/how-to/create-dns-records/#create-dns-records) - - [NameCheap](https://www.namecheap.com/support/knowledgebase/article.aspx/9646/2237/how-to-create-a-cname-record-for-your-domain/) + - [Namecheap](https://www.namecheap.com/support/knowledgebase/article.aspx/9646/2237/how-to-create-a-cname-record-for-your-domain/)🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@src/content/docs/build/domains/pointing-your-domain.mdx` around lines 98 - 100, Update the provider names in the domain setup link list: change “Godaddy” to “GoDaddy” and “NameCheap” to “Namecheap,” while leaving the URLs and Cloudflare entry unchanged.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@src/content/docs/build/domains/pointing-your-domain.mdx`:
- Line 156: Update the multi-level subdomain sentence in the domain setup
documentation to use grammatically correct wording that makes the user, rather
than the domain, responsible for adding DNS levels. Preserve the existing
guidance that additional levels must be created when needed.
---
Outside diff comments:
In `@src/content/docs/build/domains/pointing-your-domain.mdx`:
- Line 142: Update the headings in the domain documentation to use the correct
noun hyphenation: change “social sign in” to “social sign-in” and “DNS set up”
to “DNS setup.”
- Around line 98-100: Update the provider names in the domain setup link list:
change “Godaddy” to “GoDaddy” and “NameCheap” to “Namecheap,” while leaving the
URLs and Cloudflare entry unchanged.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Repository UI
Review profile: CHILL
Plan: Pro
Run ID: c6c1eaee-7032-4385-8797-734cb996b4ac
📒 Files selected for processing (1)
src/content/docs/build/domains/pointing-your-domain.mdx
| If you are using a multi-level subdomain, like `multi.subdomain.your_business.com`, how you set up DNS records will depend on how your zones are set up. | ||
|
|
||
| - Update your code to use the custom domain. | ||
| The details provided in the admin console assume the domain entered is adding a single level to your DNS zone, but if you are adding more than one level you’ll need to create others. |
There was a problem hiding this comment.
🎯 Functional Correctness | 🟡 Minor | ⚡ Quick win
Fix grammatical error in multi-level subdomain instructions.
"assume the domain entered is adding a single level" is grammatically incorrect — a domain doesn't "add" levels, the user does. This could confuse readers setting up multi-level subdomains.
✏️ Proposed fix
-The details provided in the admin console assume the domain entered is adding a single level to your DNS zone, but if you are adding more than one level you'll need to create others.
+The details provided in the admin console assume you are adding a single level to your DNS zone, but if you are adding more than one level you'll need to create others.📝 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.
| The details provided in the admin console assume the domain entered is adding a single level to your DNS zone, but if you are adding more than one level you’ll need to create others. | |
| The details provided in the admin console assume you are adding a single level to your DNS zone, but if you are adding more than one level you'll need to create others. |
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@src/content/docs/build/domains/pointing-your-domain.mdx` at line 156, Update
the multi-level subdomain sentence in the domain setup documentation to use
grammatically correct wording that makes the user, rather than the domain,
responsible for adding DNS levels. Preserve the existing guidance that
additional levels must be created when needed.
Restructured and rewrote the custom domain setup guide with clearer step-by-step instructions, field-by-field DNS setup details, provisioning status screenshots, and provider-specific links. Moved CAA records, social sign-in, and multi-level subdomains into an Advanced setup section, and expanded FAQs. Also fixed grammar, hyphenation, parallel structure, and frontmatter throughout.
Summary by CodeRabbit