aptos-core icon indicating copy to clipboard operation
aptos-core copied to clipboard

Make it possible to view API spec with sidebar layout

Open banool opened this issue 3 years ago • 1 comments

Currently the API spec viewer in aptos.dev (pending https://github.com/aptos-labs/aptos-core/pull/5345 landing) uses stacked view. Stacked view has two issues:

  1. It is harder to navigate and looks a bit busier.
  2. You can't link directly individual sections like you can with the sidebar view

It'd be nice to be able to hit a toggle and show it in sidebar view. In this case, it'd be ideal to hide the top level nav sidebar and make it full the entire width of the page.

One way to hide the sidebar easily is by just removing the doc from the sidebars and have it only linkable from the top nav bar. This doesn't make the content fill the whole width though.

banool avatar Nov 04 '22 23:11 banool

More context: https://aptos-org.slack.com/archives/C03EG004E56/p1667580759259119.

banool avatar Nov 04 '22 23:11 banool

Hi @banool , what remains here? Thanks!

clay-aptos avatar Jan 09 '23 18:01 clay-aptos

Still not done unfortunately, but this is definitely just a wishlist item.

banool avatar Jan 09 '23 23:01 banool

This issue is stale because it has been open 45 days with no activity. Remove the stale label or comment - otherwise this will be closed in 15 days.

github-actions[bot] avatar Feb 25 '23 02:02 github-actions[bot]

I think this is resolved.

davidiw avatar Apr 23 '23 00:04 davidiw

It's not but it's also not that important, so we can leave it closed. The ask here is to make it possible to view the API spec how it looks here, where there is a nav on the side: https://fullnode.devnet.aptoslabs.com/v1/spec#/.

banool avatar Apr 24 '23 10:04 banool