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

feat: add zksync-cli docs #13

Merged
merged 4 commits into from
Apr 12, 2024
Merged

feat: add zksync-cli docs #13

merged 4 commits into from
Apr 12, 2024

Conversation

itsacoyote
Copy link
Contributor

@itsacoyote itsacoyote commented Apr 11, 2024

What 💻

  • update the docs with Block Explorer page
    • condensed the block explorers pages into one
  • Update the docs with tooling/zksync-cli docs
    • Reformatted the content
  • Shifted the API Reference docs in the navigation
  • Removed noreferrer from external link component.
    • primarily for analytics purposes. I don't think it hurts to remove it, and makes it easier to track incoming for analytics.
  • Added vscode snippets file for reusable snippets.

Why ✋

  • Easier to read and navigate zksync-cli commands via the navigation

@itsacoyote itsacoyote requested a review from a team as a code owner April 11, 2024 19:54

## Other block explorers

A full list of zkSync block explorers can be found on the zkSync website's :external-link{text="Block Explorers page" href="https://zksync.io/explore#explorers"}.
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We have this comment that links to the zksync.io explore page with the list of Explorers, yet we also have this list below of explorers and sorta not explorer with NFTScan.

Is there a reason we have these two lists? We should make one the true list for explorers.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah reviewing zksync.io explore tab, its a lot of the same items we are surfacing here as well. I would rather see what we put together more enticing and better laid out.

Copy link

github-actions bot commented Apr 11, 2024

Visit the preview URL for this PR (updated for commit 7474d18):

https://zksync-docs-staging-5eb09--pr13-sf-zksync-cli-docs-lky0itva.web.app

(expires Fri, 19 Apr 2024 15:48:43 GMT)

🔥 via Firebase Hosting GitHub Action 🌎

Sign: bfaafba5fa82d4f63473aaa76a21fabf1fbb3a11

@itsacoyote itsacoyote requested a review from dutterbutter April 12, 2024 15:48
@itsacoyote itsacoyote merged commit ab7b5ab into staging Apr 12, 2024
7 checks passed
@itsacoyote itsacoyote deleted the sf-zksync-cli-docs branch April 12, 2024 20:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants