docs: Add page on domain verification #7247
Conversation
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
|
WalkthroughA new documentation page, "Verify your team email domain," was introduced, outlining the steps and benefits of domain verification. The sidebar configuration was updated to include this new page at the top of the "How to" section, and the casing of existing sidebar link titles was adjusted for consistency. Changes
Sequence Diagram(s)sequenceDiagram
User->>Portal UI: Navigate to Knowledge Base
Portal UI->>Sidebar: Render sidebar links
Sidebar-->>User: Display "Verify your team email domain" link
User->>Portal UI: Click "Verify your team email domain"
Portal UI-->>User: Show verification documentation page
✨ Finishing Touches
🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
github-actions
bot
added
the
Portal
How to use the Graphite Merge QueueAdd either label to this PR to merge it via the merge queue:
You must have a Graphite account in order to use the merge queue. Sign up using this link. An organization admin has enabled the Graphite Merge Queue in this repository. Please do not merge from GitHub as this will restart CI on PRs being processed by the merge queue. This stack of pull requests is managed by Graphite. Learn more about stacking. |
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #7247 +/- ##
=======================================
Coverage 55.55% 55.55%
=======================================
Files 908 908
Lines 58571 58571
Branches 4131 4131
=======================================
Hits 32540 32540
Misses 25927 25927
Partials 104 104
🚀 New features to boost your workflow:
|
arcoraven
force-pushed
the
06-02-docs_add_page_on_domain_verification
branch
from
3adb39e to
4cb2d98
Compare
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (2)
apps/portal/src/app/knowledge-base/how-to/verify-your-team-email-domain/page.mdx (2)
40-44: Consider improving sentence variety for better readability.The static analysis tool correctly identified repetitive sentence beginnings. Consider varying the sentence structure for better flow.
### Cloudflare -- Navigate to the Cloudflare dashboard. -- Select your zone and domain. -- Select *DNS* > *Records*. -- Select *Add record*. +- Navigate to the Cloudflare dashboard. +- Choose your zone and domain. +- Go to *DNS* > *Records*. +- Click *Add record*.🧰 Tools
🪛 LanguageTool
[style] ~43-~43: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...d domain. - Select DNS > Records. - Select Add record. [Cloudflare documentation...(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
54-58: Consider improving sentence variety for better readability.Similar to the Cloudflare section, varying the sentence beginnings would improve readability.
### Google Cloud DNS -- Navigate to the Google Cloud Console. -- Select *Network Services* > *Cloud DNS*. -- Select your zone. -- Select *Add record set*. +- Navigate to the Google Cloud Console. +- Go to *Network Services* > *Cloud DNS*. +- Choose your zone. +- Click *Add record set*.🧰 Tools
🪛 LanguageTool
[style] ~57-~57: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...s* > Cloud DNS. - Select your zone. - Select Add record set. [Google Cloud documen...(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
apps/portal/src/app/knowledge-base/how-to/verify-your-team-email-domain/page.mdx(1 hunks)apps/portal/src/app/knowledge-base/sidebar.tsx(1 hunks)
🧰 Additional context used
🪛 LanguageTool
apps/portal/src/app/knowledge-base/how-to/verify-your-team-email-domain/page.mdx
[style] ~43-~43: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...d domain. - Select DNS > Records. - Select Add record. [Cloudflare documentation...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[style] ~57-~57: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...s* > Cloud DNS. - Select your zone. - Select Add record set. [Google Cloud documen...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
⏰ Context from checks skipped due to timeout of 90000ms (4)
- GitHub Check: Size
- GitHub Check: Lint Packages
- GitHub Check: Unit Tests
- GitHub Check: Analyze (javascript)
🔇 Additional comments (3)
apps/portal/src/app/knowledge-base/how-to/verify-your-team-email-domain/page.mdx (1)
1-59: Excellent comprehensive documentation!This documentation page is well-structured and provides thorough coverage of domain verification. The content is user-friendly, includes practical examples, and covers all major DNS providers.
🧰 Tools
🪛 LanguageTool
[style] ~43-~43: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...d domain. - Select DNS > Records. - Select Add record. [Cloudflare documentation...(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[style] ~57-~57: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...s* > Cloud DNS. - Select your zone. - Select Add record set. [Google Cloud documen...(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
apps/portal/src/app/knowledge-base/sidebar.tsx (2)
25-28: Perfect integration of the new documentation page.The new sidebar entry is correctly positioned at the top of the "How to" section and properly configured with the matching href path.
30-30: Good consistency improvement with case standardization.The case changes for "soulbound" and "error" improve consistency across the sidebar links by using sentence case formatting.
Also applies to: 35-35
arcoraven
force-pushed
the
06-02-docs_add_page_on_domain_verification
branch
from
4cb2d98 to
6d52c72
Compare
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (4)
apps/portal/src/app/knowledge-base/how-to/verify-your-team-email-domain/page.mdx (4)
11-13: Use a clear, consistent placeholder for the Team Settings URL
The current link useshttps://thirdweb.com/team/~/~/settings, which may confuse readers. Consider replacing the tildes with a descriptive placeholder, e.g.:[Team Settings](https://thirdweb.com/team/<YOUR_TEAM_ID>/settings)
40-43: Vary action verbs in the Cloudflare steps
All bullets in this section start with “Select,” which feels repetitive. For example:- Select *DNS* > *Records*. - Select *Add record*. + Click *DNS* > *Records*. + Click *Add record*.🧰 Tools
🪛 LanguageTool
[style] ~43-~43: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...d domain. - Select DNS > Records. - Select Add record. [Cloudflare documentatio...(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
57-60: Reduce repeated “Select” phrasing in Google Cloud DNS section
Three back-to-back bullets start the same way. You could improve readability by swapping in synonyms:- Select *Network Services* > *Cloud DNS*. - Select your zone. - Select *Add record set*. + Open *Network Services* > *Cloud DNS*. + Choose your DNS zone. + Click *Add record set*.🧰 Tools
🪛 LanguageTool
[style] ~59-~59: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...s* > Cloud DNS. - Select your zone. - Select Add record set. [Google Cloud docume...(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
11-15: Consider explicit ordered list numbering for clarity
Although Markdown auto-numbers identical “1.” prefixes, using1.,2.,3.can help future editors distinguish steps at a glance:- 1. Navigate to [Team Settings](…). - 1. Enter your domain name. - 1. You should see instructions to add a `TXT record`. + 1. Navigate to [Team Settings](…). + 2. Enter your domain name. + 3. Follow the prompts to add a `TXT record`.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
apps/portal/src/app/knowledge-base/how-to/verify-your-team-email-domain/page.mdx(1 hunks)apps/portal/src/app/knowledge-base/sidebar.tsx(1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
- apps/portal/src/app/knowledge-base/sidebar.tsx
🧰 Additional context used
🪛 LanguageTool
apps/portal/src/app/knowledge-base/how-to/verify-your-team-email-domain/page.mdx
[style] ~43-~43: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...d domain. - Select DNS > Records. - Select Add record. [Cloudflare documentatio...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[style] ~59-~59: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...s* > Cloud DNS. - Select your zone. - Select Add record set. [Google Cloud docume...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
⏰ Context from checks skipped due to timeout of 90000ms (1)
- GitHub Check: Analyze (javascript)
🔇 Additional comments (1)
apps/portal/src/app/knowledge-base/how-to/verify-your-team-email-domain/page.mdx (1)
1-8: Great overview and benefits section
The introductory section clearly communicates the upsides of verifying your team’s domain with concise bullet points. This will help users quickly grasp why they should follow these steps.
| ```bash | ||
| $ dig +short -t txt _tw-<TEAM_ID>.<YOUR_DOMAIN> | ||
|
|
||
| # If correct, you should see this response: | ||
| "tw-verify=<YOUR_VERIFICATION_CODE>" | ||
| ``` |
There was a problem hiding this comment.
Add a closing code fence to the bash snippet
The dig example is opened with ```bash but isn’t closed, which will break the markdown rendering. Please add a closing backtick fence after the example output:
"tw-verify=<YOUR_VERIFICATION_CODE>"
+```🤖 Prompt for AI Agents
In
apps/portal/src/app/knowledge-base/how-to/verify-your-team-email-domain/page.mdx
around lines 27 to 32, the bash code block starting with ```bash is missing a
closing code fence. Add a closing triple backtick (```) after the example output
line to properly close the code block and fix the markdown rendering.
Merge activity
|
size-limit report 📦
|
[Portal] Feature: Add domain verification guide to knowledge base
Notes for the reviewer
This PR adds a new knowledge base article explaining how to verify team email domains, with step-by-step instructions and provider-specific guidance for Cloudflare, AWS Route 53, and Google Cloud DNS. It also updates the sidebar to include this new article and standardizes the capitalization of existing article titles.
How to test
Navigate to the knowledge base section and verify that the new "Verify your team email domain" article appears in the sidebar and renders correctly.
Summary by CodeRabbit
PR-Codex overview
This PR updates the
sidebar.tsxfile by modifying existing links and adding a new entry for verifying team email domains. It also introduces a newpage.mdxfile that provides detailed instructions on how to verify a domain, including steps and provider-specific guidance.Detailed summary
sidebar.tsx.href.sidebar.tsx.page.mdxwith sections on: