Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
ahmeteme authored Dec 15, 2024
1 parent 14aefa8 commit 320ee9b
Showing 1 changed file with 22 additions and 14 deletions.
36 changes: 22 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,37 +3,45 @@
[![Twitter Follow](https://img.shields.io/twitter/follow/Scroll_ZKP?style=social)](https://twitter.com/Scroll_ZKP)
[![Discord](https://img.shields.io/discord/984015101017346058?color=%235865F2&label=Discord&logo=discord&logoColor=%23fff)](https://discord.gg/scroll)

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

## Developing
## Getting Started

```
To start developing locally, run the following commands:

```bash
npm install && npm run dev
```

## Docs architecture
## Documentation Structure

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

## Tooling on Scroll
## Adding Tools to Scroll

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.
To add an entry to the [tooling list](http://docs.scroll.xyz/en/developers/scroll-contracts), follow these steps:

```
1. Create a new pull request (PR).
2. Add a new `.mdx` file to the [tooling content folder](src/content/tools).
3. Use the following template for your entry:

```yaml
---
name: "Safe"
category: ["Identity", "Wallet"]
excerpt: "Safe allows you to create smart wallet on chain."
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]
network: ["Mainnet", "Testnet"]
noAdditionalInfo: false
---

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

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

## Acknowledgments

- 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/).
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 comments on commit 320ee9b

Please sign in to comment.