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

Add "next" and "previous" footer links to APIv2 docs, for easier navigation #8658

Open
danolson1 opened this issue Nov 8, 2021 · 3 comments
Labels
api Affects the `api` project docs feature-request A request for a new feature or a change that isn't a bug. May require further triage or scoping.

Comments

@danolson1
Copy link

When reading the API v2 documentation on my phone, it would be convenient to have a link at the bottom of one section to allow you to jump right to the next section without having to navigate back to the table of contents.

For example, at the bottom of the Pipettes section, there should be a link to go to the Building Block Commands section.

@mcous mcous added robot-svcs Falls under the purview of the Robot Services squad (formerly CPX, Core Platform Experience). docs labels Dec 10, 2021
@SyntaxColoring SyntaxColoring added api Affects the `api` project feature-request A request for a new feature or a change that isn't a bug. May require further triage or scoping. labels Feb 11, 2022
@SyntaxColoring SyntaxColoring changed the title API v2 documentation navigation problem Add "next" and "previous" footer links to APIv2 docs, for easier navigation Feb 11, 2022
@SyntaxColoring SyntaxColoring removed the robot-svcs Falls under the purview of the Robot Services squad (formerly CPX, Core Platform Experience). label Jan 2, 2024
@SyntaxColoring
Copy link
Contributor

@ecormany Any opinions on this?

For example, at the bottom of the Pipettes section, there should be a link to go to the Building Block Commands section.

I'm not sure if/when this changed, but it looks like if you view docs.opentrons.com on a phone now, the full table of contents is at the bottom of the page. So in a sense, the link is there already (😛) but dedicated previous/next links might still be helpful. See e.g. https://react.dev/learn/writing-markup-with-jsx for an example of this in the wild.

@ecormany
Copy link
Contributor

ecormany commented Jan 2, 2024

I don't feel strongly about including or omitting these links, as long as they're automatic. There is no promise that the linear order of the docs won't change over time (and, in fact, they are becoming less linear as large topics get broken into subpages).

I think that the change in mobile display happened with #13349. That level of hacking is what I know can be done with our current Sphinx template, Alabaster. However, I think we may be outgrowing its abilities and I'd like to explore some broader design improvements.

I've noted this feedback internally as RTC-380, part of a larger loose collection of similar potential improvements (RTC-375).

@ecormany
Copy link
Contributor

ecormany commented Jan 2, 2024

Further detail: this is included in Alabaster, but I still want to address it at the same time as other design changes.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
api Affects the `api` project docs feature-request A request for a new feature or a change that isn't a bug. May require further triage or scoping.
Projects
None yet
Development

No branches or pull requests

4 participants