Skip to content

Redraw the README diagram in Mermaid and refresh the v1 docs - #222

Merged
ryanio merged 6 commits into
mainfrom
ryan/docs-diagram
Nov 9, 2026
Merged

ryanio merged 6 commits into
mainfrom
ryan/docs-diagram

Conversation

@ryanio

@ryanio ryanio commented Nov 9, 2026 •

Copy link
Copy Markdown
Collaborator

Motivation

The README's diagram was a PNG of ASCII art. It showed mintAllowList with a Merkle proof as the second mint path, and it left out mintSigned, the path OpenSea uses for allow lists. The README also said ERC-20 payments were a future idea, though v2 has them.

Solution

  • The README's diagram is now Mermaid, so GitHub renders it and it can be edited as text. It shows the creator configuring the token, the token forwarding settings to SeaDrop, a minter paying SeaDrop, and SeaDrop paying out and calling mintSeaDrop(). A short paragraph under it names the functions. img/seadrop-diagram.png is deleted, and nothing else links to it, opensea-docs included.
  • Background now points to v2 for ERC-1155, ERC-20 payments and multiple stages, in place of the old "future" sentence.
  • docs/SeaDropTokenDeployment.md:
    • The forge create example gets --broadcast, which Foundry 1.x needs to send the transaction.
    • The section heading level is fixed.
    • The drop URI sentence uses "onchain" and has no dashes.
  • The README is shorter, 158 lines down to 94. It drops the table of contents and tightens Background and Deployments. Install, usage, the commands and the pull request checklist move to a new docs/Development.md, and the README keeps a three-command quick start that links it. The docs list is unchanged, so this doesn't conflict with Add an agent NFT extension with ERC-8048 onchain metadata #212's new line.

Testing

  • I checked the rendered README on this branch on GitHub. The diagram renders and its labels don't overlap.
  • biome ci . passes.

🤖 Generated with Claude Code

ryanio and others added 3 commits November 8, 2026 22:19
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

🟡 Changes recommended

The README misleadingly suggests zero-fee drops need no fee recipient, although all mint entrypoints require a nonzero address, potentially causing integrations to submit reverting mints.

1 open issue
What changed in this PR

This PR refreshes SeaDrop’s v1 documentation with an editable mint-flow diagram and clearer guidance on deployment and v2 capabilities.

Changes:

  • Replaces the README’s PNG diagram with Mermaid and explains configuration, minting, and payouts.
  • Links to v2 for ERC-1155 support, ERC-20 payments, and multiple public stages.
  • Adds --broadcast to the deployment example and improves heading structure and drop URI wording.
File Description
README.md Adds the Mermaid diagram, mint-flow explanation, and v2 feature reference.
docs/​SeaDropTokenDeployment.md Updates the deployment command, heading level, and drop URI description.

Review effort: Balanced

Comment thread README.md Resolved

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

🟢 Approval recommended

No active review issues are reported for this documentation-only update to the README, deployment instructions, and contributor guidance.

No open issues 🎉

1 resolved since last review

Review effort: Balanced

@ryanio
ryanio merged commit 49a4d49 into main Nov 9, 2026
8 checks passed
@ryanio
ryanio deleted the ryan/docs-diagram branch November 9, 2026 06:38
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.

2 participants