chore(docs): Revamp resource links and enhance formatting #518
Conversation
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
WalkthroughThe changes in this pull request primarily involve formatting updates and the addition of hyperlinks across various documentation files. A new configuration file Changes
Poem
📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
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: 1
🧹 Outside diff range and nitpick comments (11)
docs/courses/courses.md (2)
10-10: Remove unnecessary line breakThe empty line between entries disrupts the consistent spacing pattern in the list. Other entries are separated by single line breaks.
Completely free and open-sourced! - - [LearnWeb3]
10-12: Consider revising subjective claims in the descriptionThe description includes a superlative claim ("the best") that may not be objectively verifiable and could diminish other valuable platforms. Consider revising to maintain a neutral, informative tone consistent with other entries.
-- [LearnWeb3](https://learnweb3.io) LearnWeb3 is the best, fastest-growing, and completely free web3 education platform for new and experienced web2 developers. +- [LearnWeb3](https://learnweb3.io) LearnWeb3 is a fast-growing, completely free web3 education platform for new and experienced web2 developers.src/resources/Project Ideas/project-ideas.md (3)
Line range hint
1-134: Improve document structure and heading hierarchyThe document has several structural inconsistencies that should be addressed:
- Inconsistent section separators (single
#vs double##)- Improper heading hierarchy (jumping from h2 to h3 without proper nesting)
- Inconsistent spacing between sections
Apply these changes throughout the document:
- Use consistent heading levels:
- Main sections should be
##(h2)- Subsections like "What you will learn" should be
###(h3)- Remove standalone
##section separators- Maintain consistent spacing (one blank line) between sections
🧰 Tools
🪛 LanguageTool
[style] ~115-~115: Consider using an alternative to strengthen your wording.
Context: ...Decentralized Video Sharing App If you want to learn about storing videos on the IP...(WANT_KEEN)
[style] ~127-~127: In American English, abbreviations like “etc.” require a period.
Context: ... share our moments with our friends and etc, but the problem is they have all our i...(ETC_PERIOD)
🪛 Markdownlint
119-119: Expected: h2; Actual: h3
Heading levels should only increment by one level at a time(MD001, heading-increment)
111-111: null
Multiple headings with the same content(MD024, no-duplicate-heading)
115-117: Enhance content clarity and presentationThe description of the video sharing app could be more concise and better structured. The source code reference should be properly integrated into the text.
Consider restructuring the content like this:
-If you want to learn about storing videos on the IPFS, saving the hash on the blockchain, adding media players, categorizing video on the app, then it would be better to build a video-sharing app similar to YouTube. You don't need to 100% do the same as YouTube, you have the freedom to redesign and create your own version of YouTube. Code a YouTube Clone with Blockchain. [Source Code](https://www.dappuniversity.com/videos/OLsteD3xkPQ) +Build a decentralized video-sharing platform similar to YouTube using blockchain technology. This project demonstrates how to store videos on IPFS, manage blockchain hashes, and implement video categorization. While inspired by YouTube, you can customize the features to create your unique platform. + +Follow along with this [tutorial on building a YouTube clone with blockchain](https://www.dappuniversity.com/videos/OLsteD3xkPQ).🧰 Tools
🪛 LanguageTool
[style] ~115-~115: Consider using an alternative to strengthen your wording.
Context: ...Decentralized Video Sharing App If you want to learn about storing videos on the IP...(WANT_KEEN)
Line range hint
24-35: Add security considerations for wallet projectsThe wallet-related projects (Ethereum Wallet and Time lock Wallet) should include important security considerations and best practices.
Consider adding these key points to both wallet projects:
- Importance of secure key management
- Best practices for handling private keys
- Common security vulnerabilities to avoid
- Testing recommendations for smart contracts
- Audit requirements before deployment
Would you like me to provide detailed security guidelines for these sections?
Also applies to: 50-59
🧰 Tools
🪛 LanguageTool
[grammar] ~21-~21: The plural noun “records” cannot be used with the article “a”. Did you mean “a new record” or “new records”?
Context: ...works. You will also learn about adding a new records to the blockchain. ## ## Ethereum Wal...(A_NNS)
🪛 Markdownlint
23-23: null
Multiple headings with the same content(MD024, no-duplicate-heading)
docs/blockchains/ethereum.md (2)
85-86: Consider updating the Chinese resource linkThe current link points to an old Ethereum wiki. Consider replacing it with the official Chinese Ethereum documentation at https://ethereum.org/zh/
81-119: Consider adding a table of contents for language sectionsTo improve navigation through the different language sections, consider adding a table of contents at the start of the language section. This would help users quickly find resources in their preferred language.
Example addition:
## 🌐 Ethereum in different languages Available languages: - [Arabic](#arabic) - [Chinese](#chinese) - [French](#french) - [German](#german) - [Hindi](#hindi) - [Italian](#italian) - [Portuguese](#portuguese) - [Spanish](#spanish) - [Turkish](#turkish) - [Vietnamese](#vietnamese)docs/roadmap/introduction.md (4)
20-20: Fix grammatical error in the sentenceThe phrase "just to don't get stuck" is grammatically incorrect. Consider revising it.
-When we want to start something new, we need some direction just to don't get stuck at the very beginning. +When we want to start something new, we need some direction to avoid getting stuck at the very beginning.🧰 Tools
🪛 LanguageTool
[grammar] ~20-~20: Are you sure the preposition ‘to’ or the verb ‘do’ is correct here?
Context: ...ething new, we need some direction just to don't get stuck at the very beginning. But w...(NEGATED_INFINITIVE)
143-146: Improve sentence variety in bullet pointsThe consecutive bullet points starting with "It's" create a repetitive structure. Consider varying the sentence beginnings for better readability.
-- It's an object-oriented, high-level language for implementing Smart Contracts. -- It's statically typed. -- It's a curly-bracket language designed to target the Ethereum Virtual Machine. -- It supports inheritance, libraries, and complex user-defined types. +- An object-oriented, high-level language for implementing Smart Contracts. +- Features static typing. +- Uses curly-bracket syntax and targets the Ethereum Virtual Machine. +- Supports inheritance, libraries, and complex user-defined types.🧰 Tools
🪛 LanguageTool
[style] ~145-~145: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...t Contracts. - It's statically typed. - It's a curly-bracket language designed to ...(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[uncategorized] ~145-~145: Although a hyphen is possible, it is not necessary in a compound modifier in which the first word is an adverb that ends in ‘ly’.
Context: ...acts. - It's statically typed. - It's a curly-bracket language designed to target the Ethereu...(HYPHENATED_LY_ADVERB_ADJECTIVE)
[style] ~146-~146: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ... target the Ethereum Virtual Machine. - It supports inheritance, libraries, and co...(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
284-292: Improve code example formatting and documentationThe JavaScript example could benefit from better documentation and consistent spacing.
// my_script.js import { ThirdwebSDK } from '@thirdweb-dev/sdk'; -// instantiate the SDK in read-only mode (our example is running on `polygon` here) -// all major chains and testnets are supported (e.g. `mainnet`, `rinkeby`, `goerli`, 'polygon', 'mumbai', etc.) +// Initialize the SDK in read-only mode for Polygon network +// Supported networks include: mainnet, rinkeby, goerli, polygon, mumbai, etc. const sdk = new ThirdwebSDK('polygon'); -// access your deployed contracts +// Access your deployed contracts const nftDrop = sdk.getNFTDrop('0x...'); const marketplace = sdk.getMarketplace('0x...');
213-215: Enhance context for Web3 libraries sectionConsider adding brief descriptions of when to use each library and their key differences to help developers make an informed choice.
-Use: +Choose the right library based on your needs: -- [Web3.js](https://web3js.readthedocs.io/): web3.js is a collection of libraries that allow you to interact with a local or remote ethereum node using HTTP, IPC or WebSocket. -- [Ether.js](https://docs.ethers.io/): The ethers.js library aims to be a complete and compact library for interacting with the Ethereum Blockchain and its ecosystem. +- [Web3.js](https://web3js.readthedocs.io/): A comprehensive collection of libraries for Ethereum interaction + - Ideal for projects requiring extensive WebSocket support + - Larger community and more established ecosystem + +- [Ethers.js](https://docs.ethers.io/): A lightweight and modern library for Ethereum interaction + - Smaller bundle size and better TypeScript support + - More secure by default with better wallet handling
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
📒 Files selected for processing (55)
.prettierrc(1 hunks)docs/SDKs/alchemysdk.md(1 hunks)docs/SDKs/moralis.md(2 hunks)docs/SDKs/sdks.md(1 hunks)docs/SDKs/thirdweb.md(1 hunks)docs/blockchains/blockchains.md(1 hunks)docs/blockchains/ethereum.md(1 hunks)docs/blockchains/polygon.md(1 hunks)docs/blockchains/solana.md(1 hunks)docs/courses/alchemy.md(2 hunks)docs/courses/courses.md(1 hunks)docs/courses/cryptozombies.md(0 hunks)docs/courses/cyfrinupdraft.md(1 hunks)docs/courses/learnweb3.md(0 hunks)docs/cross-chain/axelar.md(1 hunks)docs/cross-chain/cross-chain.md(1 hunks)docs/data-network/ceramic.md(1 hunks)docs/data-network/data-networks.md(1 hunks)docs/file-storage/arweave.md(1 hunks)docs/file-storage/file-storage.md(1 hunks)docs/file-storage/filecoin.md(1 hunks)docs/file-storage/ipfs.md(1 hunks)docs/file-storage/swarm.md(1 hunks)docs/identity/identity.md(1 hunks)docs/identity/metamask.md(1 hunks)docs/identity/phantom.md(1 hunks)docs/identity/walletconect.md(1 hunks)docs/indexing/indexing.md(1 hunks)docs/indexing/thegraph.md(1 hunks)docs/libraries/aderyn.md(1 hunks)docs/libraries/ethersjs.md(1 hunks)docs/libraries/libraries.md(1 hunks)docs/libraries/web3js.md(1 hunks)docs/libraries/web3py.md(1 hunks)docs/node-providers/Alchemy.md(1 hunks)docs/node-providers/ChainConnect.md(1 hunks)docs/node-providers/Chainstack.md(1 hunks)docs/node-providers/Infura.md(1 hunks)docs/node-providers/Quicknode.md(1 hunks)docs/notification/notification.md(1 hunks)docs/notification/pushprotocol.md(1 hunks)docs/notification/webhooks.md(1 hunks)docs/oracles/chainlink.md(1 hunks)docs/oracles/flux.md(1 hunks)docs/oracles/oracles.md(1 hunks)docs/roadmap/introduction.md(11 hunks)src/css/custom.css(15 hunks)src/pages/index.module.css(1 hunks)src/resources/Open-Source/oss.md(1 hunks)src/resources/Project Ideas/project-ideas.md(11 hunks)src/resources/Solidity/intro-to-solidity.md(2 hunks)src/resources/dao-communities/daos.md(1 hunks)src/resources/nft-marketplaces/nftmarketplaces.md(1 hunks)src/resources/twitterposts.md(1 hunks)src/resources/youtube-tutorials/yt-english.md(1 hunks)
💤 Files with no reviewable changes (2)
- docs/courses/cryptozombies.md
- docs/courses/learnweb3.md
✅ Files skipped from review due to trivial changes (44)
- .prettierrc
- docs/SDKs/alchemysdk.md
- docs/SDKs/moralis.md
- docs/SDKs/sdks.md
- docs/SDKs/thirdweb.md
- docs/blockchains/blockchains.md
- docs/blockchains/polygon.md
- docs/blockchains/solana.md
- docs/courses/alchemy.md
- docs/courses/cyfrinupdraft.md
- docs/cross-chain/axelar.md
- docs/cross-chain/cross-chain.md
- docs/data-network/ceramic.md
- docs/data-network/data-networks.md
- docs/file-storage/arweave.md
- docs/file-storage/file-storage.md
- docs/file-storage/filecoin.md
- docs/file-storage/ipfs.md
- docs/identity/identity.md
- docs/identity/metamask.md
- docs/identity/phantom.md
- docs/identity/walletconect.md
- docs/indexing/indexing.md
- docs/indexing/thegraph.md
- docs/libraries/aderyn.md
- docs/libraries/ethersjs.md
- docs/libraries/libraries.md
- docs/libraries/web3js.md
- docs/libraries/web3py.md
- docs/node-providers/Alchemy.md
- docs/node-providers/ChainConnect.md
- docs/node-providers/Chainstack.md
- docs/node-providers/Infura.md
- docs/node-providers/Quicknode.md
- docs/notification/notification.md
- docs/notification/webhooks.md
- docs/oracles/chainlink.md
- docs/oracles/oracles.md
- src/css/custom.css
- src/pages/index.module.css
- src/resources/Solidity/intro-to-solidity.md
- src/resources/dao-communities/daos.md
- src/resources/twitterposts.md
- src/resources/youtube-tutorials/yt-english.md
🧰 Additional context used
🪛 LanguageTool
docs/file-storage/swarm.md
[style] ~8-~8: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...user data, blockchain, and state data. Swarm sets out to provide various base layer ...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
docs/notification/pushprotocol.md
[style] ~7-~7: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...ralized notification protocol for Web3. Push Protocol also has built Push Chat, a we...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[uncategorized] ~7-~7: The preposition “for” seems more likely in this position than the preposition “to”.
Context: ...tive secure, wallet-to-wallet messaging to everyday users.
(AI_EN_LECTOR_REPLACEMENT_PREPOSITION_TO_FOR)
docs/oracles/flux.md
[style] ~7-~7: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...) is the trustless data layer for web3. Flux is a cross-chain oracle that provides s...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
docs/roadmap/introduction.md
[grammar] ~20-~20: Are you sure the preposition ‘to’ or the verb ‘do’ is correct here?
Context: ...ething new, we need some direction just to don't get stuck at the very beginning. But w...
(NEGATED_INFINITIVE)
[uncategorized] ~22-~22: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...ery beginning. But we all are different and we have different ways of learning. Th...
(COMMA_COMPOUND_SENTENCE)
[uncategorized] ~95-~95: Possible missing comma found.
Context: ...m Concepts Once you choose the Blockchain you can start learning the fundamentals...
(AI_HYDRA_LEO_MISSING_COMMA)
[style] ~145-~145: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...t Contracts. - It's statically typed. - It's a curly-bracket language designed to ...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[uncategorized] ~145-~145: Although a hyphen is possible, it is not necessary in a compound modifier in which the first word is an adverb that ends in ‘ly’.
Context: ...acts. - It's statically typed. - It's a curly-bracket language designed to target the Ethereu...
(HYPHENATED_LY_ADVERB_ADJECTIVE)
[style] ~146-~146: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ... target the Ethereum Virtual Machine. - It supports inheritance, libraries, and co...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[style] ~180-~180: As an alternative to the over-used intensifier ‘very’, consider replacing this phrase.
Context: ...Remix IDE](https://remix-project.org/): A very good to get started without setting up a loc...
(EN_WEAK_ADJECTIVE)
[style] ~351-~351: ‘Last but not least’ might be wordy. Consider a shorter alternative.
Context: ...DCg) --- ## Join a Community! Last but not least, joining a community can be super usefu...
(EN_WORDINESS_PREMIUM_LAST_BUT_NOT_LEAST)
src/resources/Open-Source/oss.md
[uncategorized] ~15-~15: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...s://github.com/corda/corda) Corda is an open source blockchain project, designed for busine...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
[uncategorized] ~16-~16: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...com/cosmos) ⛓️ A Framework for Building High Value Public Blockchains ✨ - [create-web3-dap...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
[grammar] ~22-~22: This term is normally spelled with a hyphen.
Context: ...s, and technology vendors with Ethereum subject matter experts. - [ethers.js](https://github.com/ether...
(SUBJECT_MATTER_HYPHEN)
[misspelling] ~27-~27: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: .../github.com/ethereum/go-ethereum) It is a Official Go Implementation of the Ether...
(EN_A_VS_AN)
[uncategorized] ~30-~30: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...erledger/) Hyperledger Foundation is an open source community focused on developing a suite...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
src/resources/Project Ideas/project-ideas.md
[style] ~115-~115: Consider using an alternative to strengthen your wording.
Context: ...Decentralized Video Sharing App If you want to learn about storing videos on the IP...
(WANT_KEEN)
src/resources/nft-marketplaces/nftmarketplaces.md
[style] ~8-~8: As an alternative to the over-used intensifier ‘very’, consider replacing this phrase.
Context: ... NFT. - Rarible A very large marketplace, partnered with Adobe. To u...
(EN_WEAK_ADJECTIVE)
🪛 Markdownlint
src/resources/Project Ideas/project-ideas.md
119-119: Expected: h2; Actual: h3
Heading levels should only increment by one level at a time
(MD001, heading-increment)
🔇 Additional comments (3)
docs/courses/courses.md (1)
Line range hint 1-24: Overall structure and consistency looks good
The new entry maintains the established format and provides relevant information consistent with other entries. The document structure effectively presents the learning platforms in a clear, organized manner.
🧰 Tools
🪛 LanguageTool
[style] ~17-~17: In American English, abbreviations like “etc.” require a period.
Context: ...ockchain, NFTs, web3 concept, DeFi, DAO etc
(ETC_PERIOD)
src/resources/Project Ideas/project-ideas.md (1)
Line range hint 1-134: Verify accessibility and relevance of external resources
Let's ensure all external links are accessible and point to appropriate resources.
✅ Verification successful
All external links are accessible and valid
All links in the markdown file have been verified and return successful HTTP responses:
- QuickNode ERC20 guide (301 redirect -> valid)
- QuickNode homepage (200)
- Dapp University blockchain tutorial (200)
- freeCodeCamp Ethereum wallet guide (200)
- Dev.to Web3 development guide (200)
- YouTube Moralis tutorial (200)
- Dapp University video tutorials (200)
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash
# Description: Check accessibility of external links in the markdown file
# Extract and verify all markdown links
echo "Checking markdown links..."
rg -o '\[([^\]]+)\]\(([^\)]+)\)' src/resources/Project\ Ideas/project-ideas.md | while read -r line; do
url=$(echo "$line" | sed -E 's/.*\((.*)\)/\1/')
echo "Checking: $url"
if [[ $url == http* ]]; then
curl -s --head "$url" | head -n 1
fi
done
Length of output: 4376
🧰 Tools
🪛 LanguageTool
[style] ~115-~115: Consider using an alternative to strengthen your wording.
Context: ...Decentralized Video Sharing App If you want to learn about storing videos on the IP...
(WANT_KEEN)
[style] ~127-~127: In American English, abbreviations like “etc.” require a period.
Context: ... share our moments with our friends and etc, but the problem is they have all our i...
(ETC_PERIOD)
🪛 Markdownlint
119-119: Expected: h2; Actual: h3
Heading levels should only increment by one level at a time
(MD001, heading-increment)
111-111: null
Multiple headings with the same content
(MD024, no-duplicate-heading)
docs/roadmap/introduction.md (1)
Line range hint 1-368: Documentation structure and content approved
The documentation provides a comprehensive guide to learning Web3 development with well-organized sections and valuable resources. The suggested improvements are mostly stylistic and don't impact the technical accuracy of the content.
🧰 Tools
🪛 LanguageTool
[style] ~9-~9: Consider a shorter alternative to avoid wordiness.
Context: ...I will summarize the steps you can take in order to learn Web3. If you prefer a video vers...
(IN_ORDER_TO_PREMIUM)
[grammar] ~20-~20: Are you sure the preposition ‘to’ or the verb ‘do’ is correct here?
Context: ...ething new, we need some direction just to don't get stuck at the very beginning. But w...
(NEGATED_INFINITIVE)
[uncategorized] ~22-~22: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...ery beginning. But we all are different and we have different ways of learning. Th...
(COMMA_COMPOUND_SENTENCE)
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Changelog
Summary by CodeRabbit
New Features
Documentation
Bug Fixes