Example descriptions in package.json
#231
Conversation
|
Caution Review failedThe pull request is closed. 📝 WalkthroughWalkthroughThis pull request encompasses comprehensive updates to the ZetaChain example repositories, focusing on renaming and refining documentation across multiple example projects. The changes standardize package names, enhance descriptions, and update tutorial links, providing a more cohesive and informative developer experience across the Call, Hello, NFT, Swap, and Token example repositories. Changes
Possibly related PRs
Tip 🌐 Web search-backed reviews and chat
📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (7)
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
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 (
|
![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 (7)
examples/token/package.json (1)
4-4: Fix grammatical error in description.The description contains a grammatical error. The phrase "to minted" should be "to be minted".
- "description": "Universal Token enables ERC-20 tokens to minted and transferred between connected chains", + "description": "Universal Token enables ERC-20 tokens to be minted and transferred between connected chains",examples/nft/package.json (1)
4-4: Fix grammatical error in description.The description contains a grammatical error. The phrase "to minted" should be "to be minted".
- "description": "Universal NFT enables non-fungible ERC-721 tokens to minted and transferred between connected chains.", + "description": "Universal NFT enables non-fungible ERC-721 tokens to be minted and transferred between connected chains.",examples/hello/README.md (1)
3-3: Format URL as proper markdown linkConvert the bare URL to a properly formatted markdown link for better readability and compliance with markdown best practices.
-Tutorial: https://www.zetachain.com/docs/developers/tutorials/hello +Tutorial: [ZetaChain Hello Tutorial](https://www.zetachain.com/docs/developers/tutorials/hello)🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
3-3: Bare URL used
null(MD034, no-bare-urls)
examples/call/README.md (1)
3-3: Format URL as proper markdown linkConvert the bare URL to a properly formatted markdown link for consistency with other documentation.
-Tutorial: https://www.zetachain.com/docs/developers/tutorials/call +Tutorial: [ZetaChain Call Tutorial](https://www.zetachain.com/docs/developers/tutorials/call)🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
3-3: Bare URL used
null(MD034, no-bare-urls)
examples/nft/README.md (1)
3-3: Standardize documentation format
- Convert the bare URL to a properly formatted markdown link
- Consider using consistent "Tutorial:" prefix as used in other examples
-Learn more: https://www.zetachain.com/docs/developers/standards/nft +Tutorial: [ZetaChain NFT Documentation](https://www.zetachain.com/docs/developers/standards/nft)🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
3-3: Bare URL used
null(MD034, no-bare-urls)
examples/swap/README.md (1)
3-3: Format URL as proper markdown linkConvert the bare URL to a properly formatted markdown link for better documentation standards.
-Tutorial: https://www.zetachain.com/docs/developers/tutorials/swap +Tutorial: [ZetaChain Swap Tutorial](https://www.zetachain.com/docs/developers/tutorials/swap)🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
3-3: Bare URL used
null(MD034, no-bare-urls)
examples/token/README.md (1)
3-3: Standardize documentation format
- Convert the bare URL to a properly formatted markdown link
- Consider using consistent "Tutorial:" prefix as used in other examples
-Learn more: https://www.zetachain.com/docs/developers/standards/token +Tutorial: [ZetaChain Token Documentation](https://www.zetachain.com/docs/developers/standards/token)🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
3-3: Bare URL used
null(MD034, no-bare-urls)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (10)
examples/call/README.md(1 hunks)examples/call/package.json(1 hunks)examples/hello/README.md(1 hunks)examples/hello/package.json(1 hunks)examples/nft/README.md(1 hunks)examples/nft/package.json(2 hunks)examples/swap/README.md(1 hunks)examples/swap/package.json(2 hunks)examples/token/README.md(1 hunks)examples/token/package.json(2 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.17.2)
examples/call/README.md
3-3: Bare URL used
null
(MD034, no-bare-urls)
examples/hello/README.md
3-3: Bare URL used
null
(MD034, no-bare-urls)
examples/nft/README.md
3-3: Bare URL used
null
(MD034, no-bare-urls)
examples/swap/README.md
3-3: Bare URL used
null
(MD034, no-bare-urls)
examples/token/README.md
3-3: Bare URL used
null
(MD034, no-bare-urls)
🔇 Additional comments (4)
examples/hello/package.json (1)
2-4: LGTM! Clear and concise package metadata.The package name and description accurately reflect the example's purpose.
examples/call/package.json (1)
2-4: LGTM! Clear and concise package metadata.The package name and description accurately reflect the example's purpose.
examples/swap/package.json (2)
2-4: LGTM! Clear and concise package metadata.The package name and description accurately reflect the example's purpose.
2-2: LGTM! Consistent versioning across examples.All example packages maintain version "1.0.0", which is good practice for a collection of related examples.
Also applies to: 3-3
|
@zeta-chain/smart-contracts please, review. |
1 similar comment
|
@zeta-chain/smart-contracts please, review. |
Summary by CodeRabbit
Documentation
Chores