Skip to content

fix: docs formatting for verified domains page #7248

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.

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

Merged

Conversation

arcoraven
Copy link
Contributor

@arcoraven arcoraven commented Jun 2, 2025

[Portal] Feature: Improve domain verification documentation formatting

Notes for the reviewer

Enhanced the domain verification documentation with better formatting:

  • Added bold formatting to key benefits
  • Improved list indentation and formatting
  • Clarified instructions with more consistent language
  • Made TXT record details more prominent
  • Refined verification instructions wording

How to test

Review the rendered MDX page to ensure the formatting improvements enhance readability and make the verification process clearer for users.

Summary by CodeRabbit

  • Documentation
    • Improved clarity and formatting of domain verification instructions, including bolded bullet points, clearer explanations, and enhanced emphasis for key terms.
    • Updated phrasing and formatting for TXT record setup steps to improve readability.
    • Reworded guidance for interpreting verification responses for better user understanding.

Copy link

vercel bot commented Jun 2, 2025

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
docs-v2 ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jun 2, 2025 9:15am
4 Skipped Deployments
Name Status Preview Comments Updated (UTC)
login ⬜️ Skipped (Inspect) Jun 2, 2025 9:15am
thirdweb_playground ⬜️ Skipped (Inspect) Jun 2, 2025 9:15am
thirdweb-www ⬜️ Skipped (Inspect) Jun 2, 2025 9:15am
wallet-ui ⬜️ Skipped (Inspect) Jun 2, 2025 9:15am

@vercel vercel bot temporarily deployed to Preview – login June 2, 2025 09:07 Inactive
@vercel vercel bot temporarily deployed to Preview – thirdweb-www June 2, 2025 09:07 Inactive
@vercel vercel bot temporarily deployed to Preview – thirdweb_playground June 2, 2025 09:07 Inactive
@vercel vercel bot temporarily deployed to Preview – wallet-ui June 2, 2025 09:07 Inactive
Copy link

changeset-bot bot commented Jun 2, 2025

⚠️ No Changeset found

Latest commit: 43e12fe

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

Copy link
Contributor

coderabbitai bot commented Jun 2, 2025

Caution

Review failed

The pull request is closed.

Walkthrough

The update revises the "Verify your team email domain" documentation page by reformatting bullet points, clarifying wording, and improving consistency. Emphasis and inline code formatting were added, and several instructional phrases were reworded for clarity. No procedural or technical steps were changed.

Changes

File(s) Change Summary
apps/portal/src/app/knowledge-base/how-to/verify-your-team-email-domain/page.mdx Reformatted bullet points, improved wording for clarity, added emphasis and inline code formatting, no technical changes

Possibly related PRs

Suggested labels

Portal


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between d150ea1 and 43e12fe.

📒 Files selected for processing (1)
  • apps/portal/src/app/knowledge-base/how-to/verify-your-team-email-domain/page.mdx (2 hunks)

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need 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)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@arcoraven arcoraven marked this pull request as ready for review June 2, 2025 09:07
@arcoraven arcoraven requested review from a team as code owners June 2, 2025 09:07
@github-actions github-actions bot added the Portal Involves changes to the Portal (docs) codebase. label Jun 2, 2025
Copy link
Contributor Author


How to use the Graphite Merge Queue

Add either label to this PR to merge it via the merge queue:

  • merge-queue - adds this PR to the back of the merge queue
  • hotfix - for urgent hot fixes, skip the queue and merge this PR next

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.

@arcoraven arcoraven added the merge-queue Adds the pull request to Graphite's merge queue. label Jun 2, 2025
Copy link
Contributor Author

Merge activity

  • Jun 2, 9:07 AM UTC: The merge label 'merge-queue' was detected. This PR will be added to the Graphite merge queue once it meets the requirements.

@arcoraven arcoraven merged commit ca08417 into main Jun 2, 2025
21 of 23 checks passed
@arcoraven arcoraven deleted the 06-02-fix_docs_formatting_for_verified_domains_page branch June 2, 2025 09:08
Copy link

codecov bot commented Jun 2, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 55.55%. Comparing base (d150ea1) to head (43e12fe).
Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #7248   +/-   ##
=======================================
  Coverage   55.55%   55.55%           
=======================================
  Files         908      908           
  Lines       58571    58571           
  Branches     4131     4131           
=======================================
  Hits        32540    32540           
  Misses      25927    25927           
  Partials      104      104           
Flag Coverage Δ
packages 55.55% <ø> (ø)
🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

Copy link
Contributor

github-actions bot commented Jun 2, 2025

size-limit report 📦

Path Size Loading time (3g) Running time (snapdragon) Total time
thirdweb (esm) 62.21 KB (0%) 1.3 s (0%) 2.8 s (+15.77% 🔺) 4 s
thirdweb (cjs) 345.12 KB (0%) 7 s (0%) 17.3 s (-1.61% 🔽) 24.2 s
thirdweb (minimal + tree-shaking) 5.7 KB (0%) 114 ms (0%) 171 ms (+16.25% 🔺) 285 ms
thirdweb/chains (tree-shaking) 531 B (0%) 11 ms (0%) 76 ms (+91.67% 🔺) 86 ms
thirdweb/react (minimal + tree-shaking) 19.54 KB (0%) 391 ms (0%) 350 ms (+26.6% 🔺) 741 ms

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
merge-queue Adds the pull request to Graphite's merge queue. Portal Involves changes to the Portal (docs) codebase.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant