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.

Sign up for GitHub

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

[EPIC] revamp left ToC for API docs #1213

Closed
7 tasks done
Eric-Arellano opened this issue Apr 19, 2024 · 0 comments
Closed
7 tasks done

[EPIC] revamp left ToC for API docs #1213

Eric-Arellano opened this issue Apr 19, 2024 · 0 comments
Labels
API docs epic 🏔️ infra 🏗️

Comments

@Eric-Arellano
Copy link
Collaborator

Eric-Arellano commented Apr 19, 2024 •
edited
Loading

Tasks
Preview Give feedback
  1. Qiskit API: group modules into logical sections #1211
    API docs infra 🏗️
    Eric-Arellano
  2. Reorganize index page for Qiskit API docs #1248
    API docs infra 🏗️
    Eric-Arellano
  3. Runtime and Provider APIs: flatten submodules in left navigation #1212
    API docs infra 🏗️
    Eric-Arellano
  4. Rename "Overview" page to "Module overview" in API ToC #1246
    API docs infra 🏗️
  5. Revisit the transpiler module pages for Runtime API docs #1240
    API docs infra 🏗️
    Eric-Arellano
  6. Truncate long module names in left ToC of API docs #1242
    API docs infra 🏗️
    Eric-Arellano
  7. Expose index page in left ToC for Runtime and Provider #1249
    API docs infra 🏗️
    Eric-Arellano
@Eric-Arellano Eric-Arellano changed the title [EPIC] revamp left nav bar for API docs [EPIC] revamp left ToC for API docs Apr 25, 2024
@Eric-Arellano Eric-Arellano mentioned this issue May 7, 2024
Merged
github-merge-queue bot pushed a commit that referenced this issue May 7, 2024
@Eric-Arellano
Remove unused ToC nesting mechanism (#1312)
c1f4896 
Thanks to #1213, we no
longer nest submodules in the left ToC. We don't plan to nest again in
the future because it limits discoverability of modules and results in
too deep of nesting.
@Eric-Arellano Eric-Arellano mentioned this issue May 13, 2024
Merged
github-merge-queue bot pushed a commit that referenced this issue May 13, 2024
@Eric-Arellano
Revert truncation of Runtime left ToC (#1358)
4c85433 
Reverts #1213. We've
gotten mixed feedback about truncating the left table of contents. While
it makes things less crowded, several people found it confusing. We'd
rather aim for clarity with our docs, even if it's more verbose.
frankharkins pushed a commit to frankharkins/documentation that referenced this issue Jul 22, 2024
@Eric-Arellano
Remove unused ToC nesting mechanism (Qiskit#1312)
e25ead8 
Thanks to Qiskit#1213, we no
longer nest submodules in the left ToC. We don't plan to nest again in
the future because it limits discoverability of modules and results in
too deep of nesting.
frankharkins pushed a commit to frankharkins/documentation that referenced this issue Jul 22, 2024
@Eric-Arellano
Revert truncation of Runtime left ToC (Qiskit#1358)
804f657 
Reverts Qiskit#1213. We've
gotten mixed feedback about truncating the left table of contents. While
it makes things less crowded, several people found it confusing. We'd
rather aim for clarity with our docs, even if it's more verbose.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
API docs epic 🏔️ infra 🏗️
Projects
Docs Planning
Archived in project
Milestone
No milestone
Development

No branches or pull requests
1 participant
@Eric-Arellano