Skip to content

README.md

Latest commit

 

History

History
47 lines (32 loc) · 1.75 KB

README.md

File metadata and controls

47 lines (32 loc) · 1.75 KB

Contribute to Scroll

Twitter Follow Discord

This repository contains the open-source project for Scroll's documentation.

Getting Started

To start developing locally, run the following commands:

npm install && npm run dev

Documentation Structure

  • All articles are written in Markdown and stored under /src/content/docs/.
  • Navigation for the documentation is managed in /src/config/sidebar.ts.

Adding Tools to Scroll

To add an entry to the tooling list, follow these steps:

  1. Create a new pull request (PR).
  2. Add a new .mdx file to the tooling content folder.
  3. Use the following template for your entry:
---
name: "Safe"
category: ["Identity", "Wallet"]
excerpt: "Safe allows you to create smart wallets on-chain."
logo: { src: "https://app.safe.global/images/safe-logo-green.png", alt: "Safe Logo" }
website: "https://app.safe.global"
network: ["Mainnet", "Testnet"]
noAdditionalInfo: false
---

Add any additional details here, such as contract addresses, tutorials, or API URLs for integrating this tool with Scroll.

Refer to existing entries in the folder for guidance if needed.

Acknowledgments

Special thanks to the Chainlink team, whose documentation served as the basis for this project. Their repository is available here, and their documentation can be viewed at https://docs.chain.link/.