Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Use smaller examples in API Documentation #1274

Closed
BenJam opened this issue Mar 13, 2017 · 3 comments
Closed

Use smaller examples in API Documentation #1274

BenJam opened this issue Mar 13, 2017 · 3 comments

Comments

@BenJam
Copy link
Contributor

BenJam commented Mar 13, 2017

The API documentation includes excessively lengthly examples that distract from the documentation itself. We should either hide example implementation on load, attach a navigation t the viewport or use smaller examples.

@andrew
Copy link
Contributor

andrew commented Mar 13, 2017

👍

@AlexandreDecan
Copy link

AlexandreDecan commented Mar 16, 2017

I would also add that the link that is displayed to test the API is not the same than the one that is encoded in the href attribute, and also differs from the one that is used to get the results that are displayed as an example.

For instance, the second link (project dependencies) is https://libraries.io/api/npm/grunt/latest/dependencies?api_key=047fd3038d6efad25fa4d7cca5ff92fc, which targets https://libraries.io/api/rubygems/rails/4.2.4/dependencies?api_key=047fd3038d6efad25fa4d7cca5ff92fc, and the results display information for base62 (which does not even have any dependency).

@andrew
Copy link
Contributor

andrew commented Oct 9, 2017

I think @BenJam fixed this

@andrew andrew closed this as completed Oct 9, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants