Skip to content

Fix typos and a broken link in English docs - #543

Open
Mibrahimwali wants to merge 3 commits into
metaplex-foundation:mainfrom
Mibrahimwali:fix/docs-typos-and-broken-link
Open

Fix typos and a broken link in English docs#543
Mibrahimwali wants to merge 3 commits into
metaplex-foundation:mainfrom
Mibrahimwali:fix/docs-typos-and-broken-link

Conversation

@Mibrahimwali

Copy link
Copy Markdown

Correct grammar and spelling issues across Core, Candy Machine, Bubblegum, and Umi pages, and point the empty collection FAQ link to the in-page section.

Correct grammar and spelling issues across Core, Candy Machine, Bubblegum, and Umi pages, and point the empty collection FAQ link to the in-page section.
@vercel

vercel Bot commented Jul 27, 2026

Copy link
Copy Markdown

@Mibrahimwali is attempting to deploy a commit to the Metaplex Foundation Team on Vercel.

A member of the Team first needs to authorize it.

@coderabbitai

coderabbitai Bot commented Jul 27, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

Warning

Review limit reached

@Mibrahimwali, you've reached your PR review limit, so we couldn't start this review.

Next review available in: 55 minutes

Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available.
You're only billed for reviews past your plan's rate limits ($0.25/file).

How can I continue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews.

How do review limits work?

CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability.

For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window.

Please refer docs for additional details.

Review details
⚙️ Run configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Pro Plus

Run ID: 78541af4-b318-42ff-b3a5-5ceb3104b0f0

📥 Commits

Reviewing files that changed from the base of the PR and between cb2bb75 and a0a95c2.

📒 Files selected for processing (2)
  • src/pages/en/smart-contracts/bubblegum/guides/javascript/how-to-create-1000000-nfts-on-solana.md
  • src/pages/en/smart-contracts/core/transfer.md

Summary by CodeRabbit

  • Documentation
    • Corrected spelling, grammar, duplicated wording, and phrasing across developer and smart contract guides.
    • Clarified generated client location and config line behavior.
    • Fixed an in-page FAQ link in the Core Asset transfer guide.
    • Corrected the transfer example’s public key definitions and collection identifier.

Walkthrough

This PR corrects wording across developer documentation. It also updates the Core transfer guide with a valid FAQ anchor and corrected public-key variables in its JavaScript example.

Changes

Documentation corrections

Layer / File(s) Summary
Guide content updates
src/pages/en/dev-tools/umi/..., src/pages/en/smart-contracts/bubblegum/..., src/pages/en/smart-contracts/candy-machine/..., src/pages/en/smart-contracts/core-candy-machine/..., src/pages/en/smart-contracts/core/external-plugins/overview.md
Corrects duplicated words, spelling, grammar, malformed prose, and the generated-client path across the documentation pages.
Core transfer guide updates
src/pages/en/smart-contracts/core/transfer.md
Adds the corresponding FAQ anchor and updates the JavaScript example to define and pass the asset, collection, and recipient public keys directly.

Estimated code review effort: 1 (Trivial) | ~3 minutes

Suggested reviewers: tonyboylehub

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly summarizes the pull request’s documentation typo fixes and broken-link correction.
Description check ✅ Passed The description accurately describes the grammar, spelling, and FAQ link changes across the documented areas.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches 💡 1
🛠️ Fix failing CI checks 💡
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Actionable comments posted: 4

🤖 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/pages/en/smart-contracts/bubblegum/guides/javascript/how-to-create-1000000-nfts-on-solana.md`:
- Line 95: Update the introductory sentence to declaratively state that the
example sets up Umi with generateSigner(umi), replacing the incorrect
generatedSigner() reference while preserving the surrounding React and
wallet-setup guidance.

In
`@src/pages/en/smart-contracts/candy-machine/custom-guards/generating-client.md`:
- Line 66: Rewrite the sentence to use a direct declarative construction and
correct punctuation, stating that the generated client is located in
`/clients/js/src` and directing the reader to navigate there after generation.

In `@src/pages/en/smart-contracts/core-candy-machine/create.md`:
- Line 288: Clarify the storage-savings sentence by stating that the Core Candy
Machine stores the name prefix once and appends each mint’s index at mint time,
reducing account storage and the associated rent cost; avoid describing bytes
themselves as rent.

In `@src/pages/en/smart-contracts/core/transfer.md`:
- Line 101: Update the transfer example containing collection.publicKey to
define collection and newOwner within the same snippet, or include explicit
setup for both before they are used. Keep the existing asset transfer flow
intact and ensure the copied example runs without ReferenceError.
🪄 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: Organization UI

Review profile: ASSERTIVE

Plan: Pro Plus

Run ID: 17744acc-7d7b-49d5-9273-2fcc65fb0ff5

📥 Commits

Reviewing files that changed from the base of the PR and between e1cf9db and 40b29bf.

📒 Files selected for processing (9)
  • src/pages/en/dev-tools/umi/getting-started/index.md
  • src/pages/en/dev-tools/umi/toolbox/token-managment.md
  • src/pages/en/smart-contracts/bubblegum/guides/javascript/how-to-create-1000000-nfts-on-solana.md
  • src/pages/en/smart-contracts/candy-machine/custom-guards/generating-client.md
  • src/pages/en/smart-contracts/candy-machine/insert-items.md
  • src/pages/en/smart-contracts/core-candy-machine/create.md
  • src/pages/en/smart-contracts/core-candy-machine/insert-items.md
  • src/pages/en/smart-contracts/core/external-plugins/overview.md
  • src/pages/en/smart-contracts/core/transfer.md

Comment thread src/pages/en/smart-contracts/candy-machine/custom-guards/generating-client.md Outdated
Comment thread src/pages/en/smart-contracts/core-candy-machine/create.md Outdated
Comment thread src/pages/en/smart-contracts/core/transfer.md Outdated
Use generateSigner(umi), clarify guard client and prefix storage wording, and make the Core collection transfer example self-contained.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

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/pages/en/smart-contracts/bubblegum/guides/javascript/how-to-create-1000000-nfts-on-solana.md`:
- Line 95: Update the explanatory text around the `generateSigner(umi)` example
to use “set up” as the verb, add the required articles, and insert the comma
that clarifies the wallet guidance while preserving the intended React and
wallet-adapter instructions.

In `@src/pages/en/smart-contracts/core/transfer.md`:
- Around line 99-100: Replace the placeholder values used by collection and
newOwner with valid Solana public-key strings that decode to 32 bytes, using
real recipient addresses or known valid base58 examples. Keep the publicKey
calls and transferV1 flow 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: Organization UI

Review profile: ASSERTIVE

Plan: Pro Plus

Run ID: 68d7b89c-3093-4d81-811b-ab503195e0d2

📥 Commits

Reviewing files that changed from the base of the PR and between 40b29bf and cb2bb75.

📒 Files selected for processing (4)
  • src/pages/en/smart-contracts/bubblegum/guides/javascript/how-to-create-1000000-nfts-on-solana.md
  • src/pages/en/smart-contracts/candy-machine/custom-guards/generating-client.md
  • src/pages/en/smart-contracts/core-candy-machine/create.md
  • src/pages/en/smart-contracts/core/transfer.md

Comment thread src/pages/en/smart-contracts/core/transfer.md Outdated
Fix remaining set up wording on the Bubblegum guide and replace invalid collection/owner placeholder keys in the Core transfer examples.
@Mibrahimwali

Copy link
Copy Markdown
Author

Hi, @MarkSackerberg,

I am trying to contribute starting from a small update PR.

Can you please review for me.

Thank you

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.

1 participant