feat: create api docs

[itsacoyote]

What :computer:

• Create API Reference Docs

Why :hand:

Evidence :camera:

Include screenshots, screen recordings, or console output here demonstrating that your changes work as intended

[github-actions[bot]]

Visit the preview URL for this PR (updated for commit 2ba2688):

https://zksync-docs-staging-5eb09--pr9-sf-create-api-docs-jybyg3t4.web.app

_{(expires Thu, 18 Apr 2024 14:46:51 GMT)}

_{🔥 via Firebase Hosting GitHub Action 🌎}

_{Sign: bfaafba5fa82d4f63473aaa76a21fabf1fbb3a11}

[dutterbutter]

Other feedback, please refer to image:

1. Looks like a number of endpoints are highlighted in table of contents rather then the first endpoint as I am at the starting of the page
2. Difficult to see the distinction between endpoints as they seem blocked together. Perhaps adding that above mentioned param description, usage example, and response will provide more division between endpoints.
3. Capitalize "API"
4. Once we finalized / documented the endpoints, we should get feedback from Roman on platform on what type of information would be useful / purposeful in an Intro or Overview section. Perhaps there is more info on rate limiting, or something else relevant that we are missing.

[itsacoyote]

@dutterbutter For the feedback about the highlight in the Table of Contents, that's a NuxtUI feature. It's designed so that it highlights all the headers that are visible on the screen as you scroll.

It does not seem like there's a way to modify that at the moment so that only the uppermost header is highlighted.

[itsacoyote]

@dutterbutter I like the cards design! I did add in some custom icons you could use, like i-zksync-zksync-logo. They're not 100% optimized, but they work in a pinch for now. You can see other custom icons I added in assets/zksync-icons.ts

[dutterbutter]

@itsacoyote I think this good to be reviewed. The en, snapshot, and net namespaces will likely live in the "Run a node" space but will get the feedback from platform. Other things I will follow up on and update iteratively are the methods that are tagged as TODO. These are not available on mainnet but will be soon.