Skip to content
This repository was archived by the owner on Jun 2, 2020. It is now read-only.

Research improved HTTP API presentation #339

Closed
jessicaschilling opened this issue Oct 3, 2019 · 4 comments
Closed

Research improved HTTP API presentation #339

jessicaschilling opened this issue Oct 3, 2019 · 4 comments
Assignees
Labels
dif/hard Having worked on the specific codebase is important effort/weeks Estimated to take multiple weeks topic/design-front-end Front-end implementation of UX/UI work topic/design-ux UX strategy, research, not solely visual design topic/infra Infrastructure

Comments

@jessicaschilling
Copy link
Contributor

jessicaschilling commented Oct 3, 2019

Research the best ways to present API reference material, keeping in mind:

  • Searchability
  • Ability to direct-link to specific calls (for use in, for example, replies in forum posts)
  • Showing only the relevant information at the right time (i.e. judiciously applied expand/collapse that doesn't break search)

Implementation of this issue lives under #225.

@ericronne ericronne added OKR 1: Beta Launch topic/design-ux UX strategy, research, not solely visual design labels Oct 3, 2019
@jessicaschilling jessicaschilling added topic/design-front-end Front-end implementation of UX/UI work dif/hard Having worked on the specific codebase is important effort/weeks Estimated to take multiple weeks labels Oct 3, 2019
@jessicaschilling
Copy link
Contributor Author

Original notes from issue #225, circa Aug 2019:

IPFS HTTP API section is hard to search and parse. The HTTP API section is currently a long list of CLI commands that one has to endlessly scroll through. It is hard to scan and quickly search for a command and argument.

When we choose our future framework, we should find a platform that will help us organize our APIs in a more user friendly fashion (i.e. includes great search).

We can alternatively use Swagger for our API Docs.

@jessicaschilling
Copy link
Contributor Author

Also see #225 (comment) for further thoughts.

@jessicaschilling
Copy link
Contributor Author

Also see #69 for additional background.

@jessicaschilling
Copy link
Contributor Author

Closing, since this issue has been consolidated into the overall effort for improving/automating API/CLI documentation in #393. Comments have been migrated there!

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
dif/hard Having worked on the specific codebase is important effort/weeks Estimated to take multiple weeks topic/design-front-end Front-end implementation of UX/UI work topic/design-ux UX strategy, research, not solely visual design topic/infra Infrastructure
Projects
None yet
Development

No branches or pull requests

3 participants