Skip to content

Commit 320ee9b

Browse files
authored
Update README.md
1 parent 14aefa8 commit 320ee9b

File tree

1 file changed

+22
-14
lines changed

1 file changed

+22
-14
lines changed

README.md

Lines changed: 22 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -3,37 +3,45 @@
33
[![Twitter Follow](https://img.shields.io/twitter/follow/Scroll_ZKP?style=social)](https://twitter.com/Scroll_ZKP)
44
[![Discord](https://img.shields.io/discord/984015101017346058?color=%235865F2&label=Discord&logo=discord&logoColor=%23fff)](https://discord.gg/scroll)
55

6-
This is the open source project for the Scroll documentation.
6+
This repository contains the open-source project for Scroll's documentation.
77

8-
## Developing
8+
## Getting Started
99

10-
```
10+
To start developing locally, run the following commands:
11+
12+
```bash
1113
npm install && npm run dev
1214
```
1315

14-
## Docs architecture
16+
## Documentation Structure
1517

16-
- All articles are markdown and stored in `/src/content/docs/`.
17-
- Navigation is JSON in `/src/config/sidebar.ts`
18+
- All articles are written in Markdown and stored under `/src/content/docs/`.
19+
- Navigation for the documentation is managed in `/src/config/sidebar.ts`.
1820

19-
## Tooling on Scroll
21+
## Adding Tools to Scroll
2022

21-
If you'd like to add an entry to our [tooling list](http://docs.scroll.xyz/en/developers/scroll-contracts), create a PR to add a new `mdx` file in the [tooling content folder](src/content/tools), using the following template. You can also refer to other existing entries for reference.
23+
To add an entry to the [tooling list](http://docs.scroll.xyz/en/developers/scroll-contracts), follow these steps:
2224

23-
```
25+
1. Create a new pull request (PR).
26+
2. Add a new `.mdx` file to the [tooling content folder](src/content/tools).
27+
3. Use the following template for your entry:
28+
29+
```yaml
2430
---
2531
name: "Safe"
2632
category: ["Identity", "Wallet"]
27-
excerpt: "Safe allows you to create smart wallet on chain."
33+
excerpt: "Safe allows you to create smart wallets on-chain."
2834
logo: { src: "https://app.safe.global/images/safe-logo-green.png", alt: "Safe Logo" }
2935
website: "https://app.safe.global"
30-
network: ["Mainnet", "Testnet]
36+
network: ["Mainnet", "Testnet"]
3137
noAdditionalInfo: false
3238
---
3339

34-
Add additional info here about how to access this tool on Scroll (ex. contract addresses, tutorials, API URLs)
40+
Add any additional details here, such as contract addresses, tutorials, or API URLs for integrating this tool with Scroll.
3541
```
3642

37-
## Credits
43+
Refer to existing entries in the folder for guidance if needed.
44+
45+
## Acknowledgments
3846

39-
- Special thanks to the Chainlink team whose documentation we forked. Their repo is available [here](https://github.com/smartcontractkit/documentation) and viewable at [https://docs.chain.link/](https://docs.chain.link/).
47+
Special thanks to the Chainlink team, whose documentation served as the basis for this project. Their repository is available [here](https://github.com/smartcontractkit/documentation), and their documentation can be viewed at [https://docs.chain.link/](https://docs.chain.link/).

0 commit comments

Comments
 (0)