Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
## Changes Made

1. Standardized terminology.
2. Improved clarity in documentation.
3. Added punctuation for consistency.
4. Enhanced link appearance.
  • Loading branch information
anonployed authored Jun 18, 2024
1 parent 07d1f80 commit 8665b89
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
[![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 is the open-source project for the Scroll documentation.

## Developing

Expand All @@ -13,9 +13,9 @@ 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`
- All articles are markdown files and stored in `/src/content/docs/`.
- Navigation is JSON in `/src/config/sidebar.ts`.

## 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/).
- Special thanks to the Chainlink team whose documentation we forked. Their repo is available [here](https://github.com/smartcontractkit/documentation) and viewable at [docs.chain.link](https://docs.chain.link/).

0 comments on commit 8665b89

Please sign in to comment.