This repository contains the open-source project for Scroll's documentation.
To start developing locally, run the following commands:
npm install && npm run dev
- All articles are written in Markdown and stored under
/src/content/docs/
. - Navigation for the documentation is managed in
/src/config/sidebar.ts
.
To add an entry to the tooling list, follow these steps:
- Create a new pull request (PR).
- Add a new
.mdx
file to the tooling content folder. - 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.
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/.