OriginProtocol/origin-docs-archived

Need separate API section

Closed this issue · 4 comments

tyleryasaka commented

Right now our origin.js API documentation is just mixed in with the rest of the docs. We have sections for things like Users and Listings, but these sections are at the same level as other sections such as Introduction. We really need a section called API that makes it clear what part of the docs pertains to the API. Either that, or we may eventually need separate documentation for the API. 🤔

micahalcorn commented

Thanks @tyleryasaka 👍

Related to OriginProtocol/origin-website#157 ☑️

I believe that the intended audience for the docs is DApp developers, and the developer landing page should be the definitive 'welcome, here are all of the places to go to learn/contribute/etc'. So I would think that these docs would be scaled down to focus on the API while some of the other stuff would move to the website.

  • 👍1
DanielVF commented

At least when I last checked, Slate only supported two levels of headlines in the left menu. It's quite helpful to be able to jump to individual API methods from the menu, which is why I made the API resources top level.

wanderingstan commented

I'm going to close this for now, as it's been a while.

That said, I'm not sure Slate is going to be the right solution for us long-term: we don't need it's feature of supporting multiple languages. Futhermore our docs site has become way more than just documenting our API methods, so the right column seems wasted most of the time.

  • 👍1
DanielVF commented

I'm also thinking slate probably won't work long term.