Navigation Menu

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

Jump to bottom

API links #269

Closed
mattheworiordan opened this issue Feb 5, 2017 · 1 comment
Closed

API links #269

mattheworiordan opened this issue Feb 5, 2017 · 1 comment
Labels
content-request A request for new content, as opposed to changing/fixing existing content

Comments

@mattheworiordan
Copy link
Member

Where we have intro docs at the top of each section, we should include an obvious link (perhaps with a uniform icon) to jump to the API docs.

Take https://www.ably.io/documentation/realtime/versions/v0.8/presence#member-list for example, a customer didn't realise there were API docs beneath. It would be easy enough to add a link such as:

"get API docs ->"
@mattheworiordan mattheworiordan added the content-request A request for new content, as opposed to changing/fixing existing content label Feb 5, 2017
@mattheworiordan
Copy link
Member Author

This is resolved in our new docs design going out this week

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
content-request A request for new content, as opposed to changing/fixing existing content
Milestone
No milestone
Development

No branches or pull requests
1 participant
@mattheworiordan