Skip to content
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

chore(docs): Revamp resource links and enhance formatting #518

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions .prettierrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"singleQuote": true,
"semi": true
}
2 changes: 1 addition & 1 deletion docs/SDKs/alchemysdk.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,4 @@ sidebar_position: 1

# Alchemy SDK

The Alchemy SDK is the easiest way to connect your dApp to the blockchain.
The [Alchemy SDK](https://www.alchemy.com/sdk) is the easiest way to connect your dApp to the blockchain.
9 changes: 2 additions & 7 deletions docs/SDKs/moralis.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ sidebar_position: 4
The Ultimate Web3 Development Platform. Integrate Web3 into any tech stack by following easy guides, recipes, and API references!

## APIs

[Web3 Data API](https://docs.moralis.io/web3-data-api/evm) Get all the blockchain data you need with our highly scalable APIs.

[Streams API](https://docs.moralis.io/streams-api/) Receive blockchain data by listing to realtime on-chain events.
Expand All @@ -32,9 +32,8 @@ The Ultimate Web3 Development Platform. Integrate Web3 into any tech stack by fo

[DeFi API](https://docs.moralis.io/web3-data-api/evm/defi-api) Get liquidity reserves and pair data across multiple blockchains.


## Integrations

[Firebase](https://docs.moralis.io/authentication-api/integrations/firebase-nodejs) Authenticate a user to your Firebase application with an EVM or Solana wallet.

[Parse Server](https://docs.moralis.io/authentication-api/integrations/parse-server-nodejs) Authenticate a user to your Parse server with MetaMask.
Expand All @@ -43,10 +42,6 @@ The Ultimate Web3 Development Platform. Integrate Web3 into any tech stack by fo

[PlayFab](https://docs.moralis.io/authentication-api/integrations/azure-playfab-nodejs-unity) Set up a complete gaming backend platform for Web3 games.



## Documentation

[Documentation](https://linktodocumentation)


4 changes: 2 additions & 2 deletions docs/SDKs/sdks.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,10 @@ sidebar_position: 1

# SDKs

SDKs are software development kits that allow you to interact with the blockchain.
SDKs are software development kits that allow you to interact with the blockchain.

They are a set of tools that allow you to build applications that interact with the blockchain.

- [Alchemy](https://www.alchemy.com/sdk) The Alchemy SDK is the easiest way to connect your dApp to the blockchain.
- [Moralis](https://moralis.io/) The Ultimate Web3 Development Platform.
- [thirdweb](https://thirdweb.com/) Smart contracts you control. Tools that accelerate your workflow. Intuitive SDKs and widgets for developers.
- [thirdweb](https://thirdweb.com/) Smart contracts you control. Tools that accelerate your workflow. Intuitive SDKs and widgets for developers.
2 changes: 1 addition & 1 deletion docs/SDKs/thirdweb.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,4 @@ sidebar_position: 4

# thirdweb

Smart contracts you control. Tools that accelerate your workflow. Intuitive SDKs and widgets for developers.
Smart contracts you control. Tools that accelerate your workflow. Intuitive SDKs and widgets for developers.
6 changes: 1 addition & 5 deletions docs/blockchains/blockchains.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
---
sidebar_position: 1


---

# Blockchains
Expand Down Expand Up @@ -50,8 +48,6 @@ sidebar_position: 1
- [Zilliqa](https://www.zilliqa.com/) Zilliqa is an ERC-20 blockchain with a focus on high transaction throughput. Currently, the Zilliqa blockchain can handle 2,828 transactions per second.
- [5ire](https://www.5ire.org/) 5ire is a layer one blockchain ecosystem designed with economic and environmental sustainability at its core. We’re one of India’s fastest growing unicorns; enabled by a community from all over the world.


### Privacy focused
## Privacy focused

- [Monero](https://www.getmonero.org/) - Private, decentralized cryptocurrency that keeps your finances confidential and secure.

29 changes: 19 additions & 10 deletions docs/blockchains/ethereum.md
Original file line number Diff line number Diff line change
Expand Up @@ -78,32 +78,41 @@ An Ethereum client is the software that allows Ethereum nodes to read the block

- [ethereum.org in different languages](https://ethereum.org/en/languages) Ethereum docs in 43 languages

### Portuguese
### Portuguese

- [Web3dev](https://www.web3dev.com.br/) Content and community for web 3 developers in Portuguese.

### Chinese
### Chinese

- [Ethereum Wiki](https://github.com/ethereum/wiki/wiki/%5B%E4%B8%AD%E6%96%87%5D-%E4%BB%A5%E5%A4%AA%E5%9D%8A%E7%99%BD%E7%9A%AE%E4%B9%A6) Ethereum Wiki in Chinese

### French
### French

- [Ethereum France](https://www.ethereum-france.com/) is the Main website for Ethereum Content, Communities, and Events in French.

### German
### German

- [Learn Solidity](https://docs.microsoft.com/de-de/learn/modules/blockchain-learning-solidity/) Microsoft website to learn Solidity in German

### Hindi
### Hindi

- [Ethereum Hindi](https://ethereum.org/hi/eth/) Main website for Ethereum Content, Communities, and Events in Hindi

### Italian
### Italian

- [Ethereum Italy](https://t.co/oyX6mujXek) Main website for Ethereum Content, Communities, and Events in Italian.

### Spanish
### Spanish

- [Cointelegraph](https://es.cointelegraph.com/ethereum-for-beginners) Ethereum guide for Web3 beginners in Spanish.

### Turkish
### Turkish

- [BTK Academy](https://www.btkakademi.gov.tr/portal/course/blokzincir-ve-kripto-paralar-10569#!/about) blockchain and cryptocurrency-focused course in Turkish.

### Vietnamese
### Vietnamese

- [Tino Group](https://wiki.tino.org/ethereum-la-gi/) Ethereum info, wallets, and FAQ in Vietnamese

### Arabic
- [Ethereum Hindi](https://ethereum.org/ar/learn/) Main website for Ethereum Content, Communities, and Events in Arabic
- [Ethereum Arabic](https://ethereum.org/ar/learn/) Main website for Ethereum Content, Communities, and Events in Arabic
8 changes: 4 additions & 4 deletions docs/blockchains/polygon.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,13 @@
sidebar_position: 2
---

# Polygon
# Polygon

Polygon (formerly MATIC Network) is an Indian blockchain scalability platform. It addresses the challenges faced by Ethereum such as high fees, poor user experience, and low transaction count per second. One of the methods used to address these issues is providing a framework for Proof of Stake transactions.
[Polygon](https://polygon.technology/) (formerly MATIC Network) is an Indian blockchain scalability platform. It addresses the challenges faced by Ethereum such as high fees, poor user experience, and low transaction count per second. One of the methods used to address these issues is providing a framework for Proof of Stake transactions.

Resources
Resources

- [PolygonBlog](https://polygon.technology/)
- [Polygon Blog](https://polygon.technology/blog)

- [Finematics](https://www.youtube.com/watch?v=IijtdpAtOt0)

Expand Down
2 changes: 1 addition & 1 deletion docs/blockchains/solana.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ sidebar_position: 3

![image](https://user-images.githubusercontent.com/89864818/193443511-1a552e0f-199f-465d-a492-187aca0620bf.png)
Solana is a public blockchain platform with smart contract functionality. Its native cryptocurrency is SOL.
Solana achieves consensus using a proof-of-stake mechanism and its model, known as "proof-of-history" mechanism. Proof of history enables the network to operate faster because nodes do not need to communicate to validate a block. The Solana whitepaper describes this design as a decentralized clock.
Solana achieves consensus using a proof-of-stake mechanism and its model, known as "proof-of-history" mechanism. Proof of history enables the network to operate faster because nodes do not need to communicate to validate a block. The Solana whitepaper describes this design as a decentralized clock.

- [Getting Started with Solana](https://docs.solana.com/developing/clients/javascript-api)
- [Complete Guide to Full Stack Solana Development by Nader Dabit](https://dev.to/edge-and-node/the-complete-guide-to-full-stack-solana-development-with-react-anchor-rust-and-phantom-3291)
Expand Down
5 changes: 2 additions & 3 deletions docs/courses/alchemy.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,7 @@ sidebar_position: 2

# Alchemy University

[Alchemy](https://university.alchemy.com/) University is an online educational platform that provides free, self-paced courses on building Web3 applications.University are designed to provide students with a comprehensive understanding of Web3 development, covering courses such as basic coding, web3 bootcamp, and bliding web3 project.

[Alchemy](https://university.alchemy.com/) University is an online educational platform that provides free, self-paced courses on building Web3 applications.University are designed to provide students with a comprehensive understanding of Web3 development, covering courses such as basic coding, web3 bootcamp, and bliding web3 project.

<a href='https://twitter.com/AlchemyPlatform' >
<img src="https://skillicons.dev/icons?i=twitter" height='40'/>
Expand All @@ -19,4 +18,4 @@ sidebar_position: 2
</a>
<a href='https://university.alchemy.com/discord'>
<img src="https://skillicons.dev/icons?i=discord" height='40' />
</a>
</a>
2 changes: 1 addition & 1 deletion docs/courses/courses.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,11 @@ sidebar_position: 1
- [Cyfrin Updraft](https://updraft.cyfrin.io) Cyfrin Updraft is the leading smart contract development and security learning platform. With 50+ hours of courses and 300 videos and written lessons, to go from zero to blockchain hero, completely for free.

Completely free and open-sourced!

- [LearnWeb3](https://learnweb3.io) LearnWeb3 is the best, fastest-growing, and completely free web3 education platform for new and experienced web2 developers.

- [Crypto Zombies](https://cryptozombies.io/) CryptoZombies is an interactive school that teaches you all things technical about blockchains. Learn to write smart contracts by making your own crypto-collectibles game.

- [Alchemy University](https://university.alchemy.com/) Alchemy University is a free, self-paced, online course that teaches you how to build Web3 applications.

- [Odyssey](https://www.cryptostudyhall.xyz/) It is a great site to understand the concepts of Web3 on other topics that are related to web3. For Example, blockchain, NFTs, web3 concept, DeFi, DAO etc

1 change: 0 additions & 1 deletion docs/courses/cryptozombies.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,6 @@ sidebar_position: 4

# Cryptozombies


[CryptoZombies](https://cryptozombies.io/) is an interactive school that teaches you all things technical about blockchains. Learn to write smart contracts by making your own crypto-collectibles game.

<a href='https://github.com/CryptozombiesHQ/' >
Expand Down
6 changes: 3 additions & 3 deletions docs/courses/cyfrinupdraft.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,17 +5,17 @@ sidebar_position: 2
# Cyfrin Updraft

[Cyfrin Updraft](https://updraft.cyfrin.io/) is the leading smart contract development learning platform to kickstart your career and build real-world projects, guided by industry-leading experts.
Learn smart contract development, smart contract security, zero knowledge proof, and everything you need to know to become a smart contract engineer or security researcher.
Learn smart contract development, smart contract security, zero knowledge proof, and everything you need to know to become a smart contract engineer or security researcher.
Learn through step-by-step tutorials and projects taught by the world's best educator:

- [Blockchain fundamentals](https://updraft.cyfrin.io/courses/blockchain-basics)
- [Solidity 101](https://updraft.cyfrin.io/courses/solidity)
- [Foundry fundamentals](https://updraft.cyfrin.io/courses/foundry)
- [Foundry advanced](https://updraft.cyfrin.io/courses/advanced-foundry)
- [Foundry advanced](https://updraft.cyfrin.io/courses/advanced-foundry)
- [Smart contract security](https://updraft.cyfrin.io/courses/security)
- [Assemble and formal verification](https://updraft.cyfrin.io/courses/formal-verification)
- [Smart Contract Devops](https://updraft.cyfrin.io/courses/wallets)

<a href='https://x.com/CyfrinUpdraft' >
<img src="https://skillicons.dev/icons?i=twitter" height='40' alt="Twitter"/>
</a>
Expand Down
7 changes: 0 additions & 7 deletions docs/courses/learnweb3.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,10 +17,3 @@ sidebar_position: 4
<img height='30' src="https://skillicons.dev/icons?i=github" />
</a>
</p>







7 changes: 3 additions & 4 deletions docs/cross-chain/axelar.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,16 +4,15 @@ sidebar_position: 1

# Axelar

Axelar delivers secure cross-chain communication for Web3, enabling you to build Interchain dApps that grow beyond a single chain.
[Axelar](https://axelar.network/) delivers secure cross-chain communication for Web3, enabling you to build Interchain dApps that grow beyond a single chain.

**Secure** means Axelar is built on proof-of-stake, the battle-tested approach used by Ethereum, Polygon, Cosmos, and more.
**Secure** means Axelar is built on proof-of-stake, the battle-tested approach used by Ethereum, Polygon, Cosmos, and more.

**Cross-chain** communication means you can build a complete experience for your users that lets them interact with any asset, any application, on any chain with one click.


## Resources

- [Axelar Documentation](https://docs.axelar.dev/)
- [Axelar Examples](https://github.com/axelarnetwork/axelar-examples)
- [Axelar Developer Tutorials](https://www.youtube.com/@Axelarcore/videos)
- [Axelar JS SDK](https://github.com/axelarnetwork/axelarjs-sdk)
- [Axelar JS SDK](https://github.com/axelarnetwork/axelarjs-sdk)
2 changes: 1 addition & 1 deletion docs/cross-chain/cross-chain.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,4 @@ sidebar_position: 1

Cross-chain bridges are software-based interoperability solutions that are designed to enable seamless interactivity between blockchains. Simply put, they employ smart contracts to enable the transfers of assets and data between different blockchain networks that would otherwise operate in isolation.

- [Axelar](https://axelar.network/) delivers secure cross-chain communication for Web3, enabling you to build Interchain dApps that grow beyond a single chain.
- [Axelar](https://axelar.network/) delivers secure cross-chain communication for Web3, enabling you to build Interchain dApps that grow beyond a single chain.
3 changes: 1 addition & 2 deletions docs/data-network/ceramic.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,5 +4,4 @@ sidebar_position: 1

# Ceramic Network

(https://ceramic.network/) Ceramic is a decentralized data network that brings unlimited data composability to Web3 applications.

[Ceramic Network](https://ceramic.network/) is a decentralized data network that brings unlimited data composability to Web3 applications.
3 changes: 1 addition & 2 deletions docs/data-network/data-networks.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,5 +5,4 @@ sidebar_position: 1
# Data Networks

- [Ceramic Network](https://ceramic.network/) Ceramic is a decentralized data network that brings unlimited data composability to Web3 applications.
- Ceramic is built on a completely peer-to-peer network, all documents are openly discoverable and can be referenced by other documents or queried by any other participant on the network.

- Ceramic is built on a completely peer-to-peer network, all documents are openly discoverable and can be referenced by other documents or queried by any other participant on the network.
2 changes: 1 addition & 1 deletion docs/file-storage/arweave.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,4 @@ sidebar_position: 2

# Arweave

Arweave enables you to store documents and applications forever.
[Arweave](https://www.arweave.org/) enables you to store documents and applications forever.
2 changes: 1 addition & 1 deletion docs/file-storage/file-storage.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,4 +9,4 @@ Decentralized Storage [thread](https://twitter.com/FrancescoCiull4/status/148329
- [Arweave](https://www.arweave.org/) Arweave enables you to store documents and applications forever.
- [Filecoin](https://filecoin.io/) Filecoin is an open-source, public cryptocurrency and digital payment system intended to be a blockchain-based cooperative digital storage and data retrieval method.
- [IPFS](https://ipfs.io/) A peer-to-peer hypermedia protocol designed to preserve and grow humanity's knowledge by making the web upgradeable, resilient, and more open.
- [Swarm](https://ethersphere.github.io/swarm-home/) Swarm is a distributed storage platform and content distribution service, a native base layer service of the Ethereum web3 stack that aims to provide a decentralized and redundant store for dapp code, user data, blockchain, and state data. Swarm sets out to provide various base layer services for web3, including node-to-node messaging, media streaming, decentralized database services, and scalable state-channel infrastructure for decentralized service economies.
- [Swarm](https://ethersphere.github.io/swarm-home/) Swarm is a distributed storage platform and content distribution service, a native base layer service of the Ethereum web3 stack that aims to provide a decentralized and redundant store for dapp code, user data, blockchain, and state data. Swarm sets out to provide various base layer services for web3, including node-to-node messaging, media streaming, decentralized database services, and scalable state-channel infrastructure for decentralized service economies.
2 changes: 1 addition & 1 deletion docs/file-storage/filecoin.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,4 @@ sidebar_position: 3

# Filecoin

Filecoin is an open-source, public cryptocurrency and digital payment system intended to be a blockchain-based cooperative digital storage and data retrieval method.
[Filecoin](https://filecoin.io/) is an open-source, public cryptocurrency and digital payment system intended to be a blockchain-based cooperative digital storage and data retrieval method.
2 changes: 1 addition & 1 deletion docs/file-storage/ipfs.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,4 @@ sidebar_position: 4

# IPFS

IPFS ios a peer-to-peer hypermedia protocol designed to preserve and grow humanity's knowledge by making the web upgradeable, resilient, and more open.
[IPFS](https://ipfs.io/) ios a peer-to-peer hypermedia protocol designed to preserve and grow humanity's knowledge by making the web upgradeable, resilient, and more open.
4 changes: 2 additions & 2 deletions docs/file-storage/swarm.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,6 @@ sidebar_position: 5

# Swarm

Swarm is a distributed storage platform and content distribution service, a native base layer service of the Ethereum web3 stack that aims to provide a decentralized and redundant store for dapp code, user data, blockchain, and state data.
[Swarm](https://ethersphere.github.io/swarm-home/) is a distributed storage platform and content distribution service, a native base layer service of the Ethereum web3 stack that aims to provide a decentralized and redundant store for dapp code, user data, blockchain, and state data.

Swarm sets out to provide various base layer services for web3, including node-to-node messaging, media streaming, decentralized database services, and scalable state-channel infrastructure for decentralized service economies.
Swarm sets out to provide various base layer services for web3, including node-to-node messaging, media streaming, decentralized database services, and scalable state-channel infrastructure for decentralized service economies.
2 changes: 1 addition & 1 deletion docs/identity/identity.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,4 @@ sidebar_position: 1

- [MetaMask](https://metamask.io) MetaMask is a software cryptocurrency wallet used to interact with the Ethereum blockchain.
- [Phantom](https://phantom.app/) Phantom makes it safe & easy for you to store, buy, send, receive, swap tokens and collect NFTs on the Solana blockchain.
- [WalletConnect](https://walletconnect.com/) WalletConnect is the web3 standard to connect blockchain wallets to dapps.
- [WalletConnect](https://walletconnect.com/) WalletConnect is the web3 standard to connect blockchain wallets to dapps.
2 changes: 1 addition & 1 deletion docs/identity/metamask.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,4 @@ sidebar_position: 2

# Metamask

MetaMask is a software cryptocurrency wallet used to interact with the Ethereum blockchain.
[MetaMask](https://metamask.io) is a software cryptocurrency wallet used to interact with the Ethereum blockchain.
2 changes: 1 addition & 1 deletion docs/identity/phantom.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,4 @@ sidebar_position: 4

# Phantom

Phantom makes it safe & easy for you to store, buy, send, receive, swap tokens and collect NFTs on the Solana blockchain.
[Phantom](https://phantom.app/) makes it safe & easy for you to store, buy, send, receive, swap tokens and collect NFTs on the Solana blockchain.
2 changes: 1 addition & 1 deletion docs/identity/walletconect.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,4 @@ sidebar_position: 3

# WalletConnect

WalletConnect is the web3 standard to connect blockchain wallets to dapps.
[WalletConnect](https://walletconnect.com/) is the web3 standard to connect blockchain wallets to dapps.
2 changes: 1 addition & 1 deletion docs/indexing/indexing.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,4 @@ sidebar_position: 1

# Indexing

- [The Graph](https://thegraph.com/en/) The Graph is an indexing protocol for querying networks like Ethereum and IPFS.
- [The Graph](https://thegraph.com/en/) The Graph is an indexing protocol for querying networks like Ethereum and IPFS.
2 changes: 1 addition & 1 deletion docs/indexing/thegraph.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,4 @@ sidebar_position: 1

# The Graph

The Graph is an indexing protocol for querying networks like Ethereum and IPFS.
[The Graph](https://thegraph.com/en/) is an indexing protocol for querying networks like Ethereum and IPFS.
7 changes: 7 additions & 0 deletions docs/libraries/aderyn.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
sidebar_position: 5
---

# Aderyn

[Aderyn](https://github.com/Cyfrin/aderyn) is a Rust-based solidity smart contract static analyzer designed to help protocol engineers and security researchers find vulnerabilities in Solidity code bases.
Loading