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

Create a standard sidebar structure in layout.html #70

Closed
javabster opened this issue Aug 25, 2022 · 1 comment · Fixed by #138
Closed

Create a standard sidebar structure in layout.html #70

javabster opened this issue Aug 25, 2022 · 1 comment · Fixed by #138
Assignees
Labels
documentation Improvements or additions to documentation
Milestone

Comments

@javabster
Copy link
Collaborator

The layout.html should have a standard structure that can be pulled in by all qiskit repos.

Current plan:

[language dropdown]

[search box]

Qiskit {Repo Name} Documentation
   Overview
   Getting Started
   Tutorials
   How to Guides
   API Reference
   FAQs
   Release Notes
   GitHub

[previous releases list]

Open questions for discussion:

  • Should we require every page listed above or just some or none?
  • Which pages should we insist be there and which should be optional?
  • Should we allow individual repos to add their own links to the sidebar list?

cc: @HuangJunye @agebbie

@javabster javabster added the documentation Improvements or additions to documentation label Aug 25, 2022
@javabster javabster moved this to Backlog in Qiskit Sphinx Theme Aug 25, 2022
@javabster
Copy link
Collaborator Author

javabster commented Sep 27, 2022

Updated standard structure from discussion today:

# Standard - Must haves
Overview
Getting Started (installation + hello world + link to tutorials)
Tutorials
How-to Guides
API Reference
Explanations
Release Notes
GitHub

# Standard - recommended but not mandatory
Previous Releases

# Optional Extras
blank box we can fill with optionals e.g. FAQs

@javabster javabster mentioned this issue Oct 6, 2022
6 tasks
@javabster javabster moved this from Backlog to In Progress in Qiskit Sphinx Theme Oct 11, 2022
@javabster javabster self-assigned this Oct 11, 2022
@javabster javabster mentioned this issue Nov 30, 2022
7 tasks
@javabster javabster added this to the v1.11.0 milestone Dec 7, 2022
@javabster javabster moved this from In Progress to In Review in Qiskit Sphinx Theme Dec 7, 2022
@github-project-automation github-project-automation bot moved this from In Review to Done in Qiskit Sphinx Theme Feb 21, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
No open projects
Status: Done
1 participant