Skip to content

Commit

Permalink
Update/repo banner (#83)
Browse files Browse the repository at this point in the history
* update: new banner

* add badges
  • Loading branch information
dghelm authored Sep 6, 2023
1 parent d15b2f6 commit b4f11e9
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 5 deletions.
11 changes: 6 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
![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
Expand All @@ -8,13 +13,9 @@ npm install && npm run dev

## Docs architecture

- All docs are markdown and stored in `/src/pages`.
- All articles are markdown and stored in `/src/content/docs/`.
- Navigation is JSON in `/src/config/sidebar.ts`

## Deployment

Managed by Scroll using Netlify at https://app.netlify.com/sites/scroll-documentation/overview.

## 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/).
Binary file added src/assets/banner.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit b4f11e9

Please sign in to comment.