Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: readme cleanup #584

Merged
merged 1 commit into from
Sep 19, 2024
Merged

docs: readme cleanup #584

merged 1 commit into from
Sep 19, 2024

Conversation

tomimor
Copy link
Contributor

@tomimor tomimor commented Sep 19, 2024

Motivation

Incorporating the foundry book has led to updates in most sections of the readme. The main motivation for this cleanup is to maintain a single source of truth for documentation, present information in a straightforward manner, and provide useful links for quick access.

Solution

  • Erase duplicated sections from the readme that are being explained in the book.
  • Sync communication with the one ZKsync is using to describe Foundry.
  • Format & descriptions polishing

@tomimor tomimor added the documentation 📖 Improvements or additions to documentation label Sep 19, 2024
@tomimor tomimor self-assigned this Sep 19, 2024
@tomimor tomimor marked this pull request as ready for review September 19, 2024 12:54
@nbaztec nbaztec merged commit d9af657 into main Sep 19, 2024
11 checks passed
@nbaztec nbaztec deleted the readme-update branch September 19, 2024 13:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation 📖 Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants