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

feat(website): add index sections to reference and resources #13490

Merged
merged 9 commits into from
Apr 5, 2023
20 changes: 19 additions & 1 deletion packages/website/pages/docs/reference.mdx
Original file line number Diff line number Diff line change
@@ -1 +1,19 @@
Handy reference documentation for Taiko.
## Handy reference documentation for Taiko.

### [Contract Documentation](reference/contract-documentation)

This section contains the documentation related to different smart contracts deployed on the blockchain. It includes information about the contract's functionality, usage, and interfaces. The documentation also covers the technical details, such as the contract's bytecode, source code, and compiler version.

### [Contract Addresses](reference/contract-addresses)

This section provides the list of contract addresses deployed on the blockchain. It includes information about the contract's name, version, and the network it's deployed on. These addresses are crucial for interacting with the contracts using the various blockchain tools and libraries.

### [Protocol Constants](reference/protocol-constants)

This section provides the protocol constants that are fundamental to the blockchain's operation. These constants include block gas limits, chain IDs, EVM opcodes, and other network parameters. Understanding these constants is essential for building applications on the blockchain.
d1onys1us marked this conversation as resolved.
Show resolved Hide resolved

### [RPC Configuration](reference/rpc-configuration)

This section provides the details of the RPC configuration required for interacting with the blockchain. It includes information about the endpoint URLs, the supported JSON-RPC methods, and the parameters required for each method. The RPC configuration is crucial for building applications that interact with the blockchain.

**_With this guide, you should be able to navigate and understand the various sections related to contracts, protocol constants, contract addresses, and RPC configuration._**
d1onys1us marked this conversation as resolved.
Show resolved Hide resolved
24 changes: 23 additions & 1 deletion packages/website/pages/docs/resources.mdx
Original file line number Diff line number Diff line change
@@ -1 +1,23 @@
Useful resources for learning about Taiko.
## Useful resources for learning about Taiko.

### [Contributing](resources/contributing)

This section contains information on how to contribute to the Taiko Protocol on GitHub. It includes guidelines for reporting issues, submitting pull requests, and contributing to the documentation.

### [Official Links](resources/official-links)

This section provides a list of official links related to the Taiko Protocol. It includes links to the official website, GitHub repository, and social media channels.

### [Presentations](resources/presentations)

This section contains presentations related to the Taiko Protocol. It includes videos and slides from conferences, webinars, and other events.

### [Rollup Glossary](resources/rollup-glossary)

This section provides a glossary of terms related to Rollup technology. It includes definitions and explanations of key concepts and terms.

### [Whitepaper](resources/whitepaper)

This section contains the official Taiko Protocol whitepaper. It includes a detailed overview of the technology, its benefits, and its use cases.
d1onys1us marked this conversation as resolved.
Show resolved Hide resolved

**_With this guide, you should be able to navigate and access different resources related to Taiko Protocol._**
d1onys1us marked this conversation as resolved.
Show resolved Hide resolved