|
3 | 3 | [](https://twitter.com/Scroll_ZKP)
|
4 | 4 | [](https://discord.gg/scroll)
|
5 | 5 |
|
6 |
| -This is the open source project for the Scroll documentation. |
| 6 | +This repository contains the open-source project for Scroll's documentation. |
7 | 7 |
|
8 |
| -## Developing |
| 8 | +## Getting Started |
9 | 9 |
|
10 |
| -``` |
| 10 | +To start developing locally, run the following commands: |
| 11 | + |
| 12 | +```bash |
11 | 13 | npm install && npm run dev
|
12 | 14 | ```
|
13 | 15 |
|
14 |
| -## Docs architecture |
| 16 | +## Documentation Structure |
15 | 17 |
|
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`. |
18 | 20 |
|
19 |
| -## Tooling on Scroll |
| 21 | +## Adding Tools to Scroll |
20 | 22 |
|
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: |
22 | 24 |
|
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 |
24 | 30 | ---
|
25 | 31 | name: "Safe"
|
26 | 32 | 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." |
28 | 34 | logo: { src: "https://app.safe.global/images/safe-logo-green.png", alt: "Safe Logo" }
|
29 | 35 | website: "https://app.safe.global"
|
30 |
| -network: ["Mainnet", "Testnet] |
| 36 | +network: ["Mainnet", "Testnet"] |
31 | 37 | noAdditionalInfo: false
|
32 | 38 | ---
|
33 | 39 |
|
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. |
35 | 41 | ```
|
36 | 42 |
|
37 |
| -## Credits |
| 43 | +Refer to existing entries in the folder for guidance if needed. |
| 44 | + |
| 45 | +## Acknowledgments |
38 | 46 |
|
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