delvtech / hyperdrive

An automated market maker for fixed and variable yield with on-demand terms.
Apache License 2.0
36 stars 4 forks source link

Link to all tool docs pages from `docs.hyperdrive.box` #1055

Open dpaiton opened 5 months ago

dpaiton commented 5 months ago
MazyGio commented 5 months ago

There's a Developer Resources page in the docs. Could you all please help confirm that the links point where we want them to point to? @ryangoree @dpaiton @jalextowle

Also feel free to comment about any other tools we want to mention here, or suggest any changes to how we list/present these.

Thanks!

dpaiton commented 5 months ago

can you change the agent0 link to https://agent0.readthedocs.io/en/latest/index.html? that's our docs homepage

MazyGio commented 5 months ago

Done! You may not see it live for a bit due to (I think) caching issues, but the change was merged into Gitbook

dpaiton commented 5 months ago

I think what we currently have is acceptable, so if this is too much of a lift before mainnet I'm fine with leaving it alone. But since the thread is here I'll add my $0.02.

@jrhea had proposed this originally:

hyperdrive.delv.tech/docs

  • smart contracts
  • SDK
  • simulation
  • bots

I like the spirit of what he's proposing -- I think the first thing a person should see when they come to our docs page is a list of links to get them where they want to go. While the "learn about hyperdrive" intro page is nice, it is much less likely to get repeat traffic. Developers are the people that will be coming back to the docs again and again, and their experience should be prioritized imo.

@ryangoree made a really nice landing page for the SDK docs:

image

I think docs.hyperdrive.box should show a page just like this, with buttons for places people want to go. I'm totally guessing at the ordering here, and don't really care what it is ultimately, but here are the buttons I'd suggest:

The idea is we want to be 1) less opinionated about what people need to see when they're digging into hyperdrive and 2) we want to expose all of the options to them quickly. Put in the back of their mind when they come to see the docs (oh wow I can integrate my [rs/py/js] project with them, I'll look into that later).

dpaiton commented 5 months ago

I just discovered this page:

https://hyperdrive.box/build

It has boxes for each build library, maybe we can make those clickable? This is probably redundant with the suggestion above. I would suggest getting rid of /build and having docs.hyperdrive.box behave as above