Add section for suave-std api

flashbots / suave-docs

https://suave.flashbots.net

Creative Commons Attribution 4.0 International

6 stars 6 forks source link

Add section for suave-std api #92

Closed ferranbt closed 6 months ago

ferranbt commented 6 months ago

This PR does two things:

It introduces another docusaurus/plugin-content-docs to host suave-std documentation.
It uses the suave-std docs generator tool to create an API reference. Note that right now the content was moved manually. The idea is to have an automation tool to create sync up PRs as soon as the docs on suave-std change.

This PR is dependant on https://github.com/flashbots/suave-std/pull/62 being merged first. This is a reference to see how the markdown files look like.

vercel[bot] commented 6 months ago

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
suave-docs	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Mar 14, 2024 8:26am

metachris commented 6 months ago

Nice! Perhaps adding it into the existing docs would be better than adding a whole new docs section 🤔

The formatting looks a bit plain, but we can improve that over time.

ferranbt commented 6 months ago

Nice! Perhaps adding it into the existing docs would be better than adding a whole new docs section

I am expecting that section to grow over time with more examples or specific docs on Forge integration. We can put it into docs and move it out if it once it grows.

The formatting looks a bit plain, but we can improve that over time.

Agree, that is just the default format.