Truncate left ToC entries for Runtime and Provider #1250
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
frankharkins
approved these changes
Apr 30, 2024
frankharkins
pushed a commit
to frankharkins/documentation
that referenced
this pull request
Jul 22, 2024
Closes Qiskit#1242. We decided with design that the simplest solution to the visual clutter is to truncate. Before: <img width="264" alt="Screenshot 2024-04-26 at 5 04 55 PM" src="https://github.com/Qiskit/documentation/assets/14852634/df90b11d-d779-4832-9541-92220e39d0c7"> After: <img width="269" alt="Screenshot 2024-04-26 at 5 05 51 PM" src="https://github.com/Qiskit/documentation/assets/14852634/d4643c74-c711-4219-a297-845864f09ca2"> ## Does not add a hover We were hoping to allow you to hover to see the full text, like you do with links via `title`, where we show you the full module path. But I could not see an easy way to do this because this is plain text rather than a hover. We'd need to add a new mechanism to `_toc.json` where you can set something like `hoverTitle` for each entry, and then we'd need to add a new mechanism to the docs app. So, I didn't add this for now. I think it's obvious enough, especially because we show you the full import path at the top of the module overview page: <img width="654" alt="Screenshot 2024-04-26 at 5 06 14 PM" src="https://github.com/Qiskit/documentation/assets/14852634/dd3c9c6b-9274-4317-b090-8804c1725a23">
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Closes #1242. We decided with design that the simplest solution to the visual clutter is to truncate.
Before:
After:
Does not add a hover
We were hoping to allow you to hover to see the full text, like you do with links via
title, where we show you the full module path.But I could not see an easy way to do this because this is plain text rather than a hover. We'd need to add a new mechanism to
_toc.jsonwhere you can set something likehoverTitlefor each entry, and then we'd need to add a new mechanism to the docs app. So, I didn't add this for now.I think it's obvious enough, especially because we show you the full import path at the top of the module overview page:
