https://github.com/scroll-tech/scroll-documentation

This is the frontend for the Scroll documentation
https://github.com/scroll-tech/scroll-documentation

Last synced: 8 months ago
JSON representation

This is the frontend for the Scroll documentation

• Host: GitHub
• URL: https://github.com/scroll-tech/scroll-documentation
• Owner: scroll-tech
• License: mit
• Created: 2023-01-26T22:21:57.000Z (almost 3 years ago)
• Default Branch: develop
• Last Pushed: 2025-04-11T08:55:35.000Z (9 months ago)
• Last Synced: 2025-04-11T10:55:08.332Z (9 months ago)
• Language: MDX
• Homepage:
• Size: 55.8 MB
• Stars: 582
• Watchers: 22
• Forks: 192
• Open Issues: 82
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

          
![Contribute to Scroll](./src/assets/banner.png)

[![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.

## Developing

```

npm install && npm run dev

```

## Docs architecture

- All articles are markdown and stored in `/src/content/docs/`.

- Navigation is JSON in `/src/config/sidebar.ts`

## Tooling on 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.

```

---

name: "Safe"

category: ["Identity", "Wallet"]

excerpt: "Safe allows you to create smart wallet 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 additional info here about how to access this tool on Scroll (ex. contract addresses, tutorials, API URLs)

```

## Credits

- 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/).