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

Review and Refactor breadcrumbs.html #114

Closed
javabster opened this issue Oct 24, 2022 · 1 comment · Fixed by #185
Closed

Review and Refactor breadcrumbs.html #114

javabster opened this issue Oct 24, 2022 · 1 comment · Fixed by #185
Assignees
Labels
Milestone

Comments

@javabster
Copy link
Collaborator

The breadcrumb component needs a review and to be refactored to display headings that make more sense. E.g. the root title should not be "Docs" but should reflect the name of the specific repo the docs is rendering for. In addition there is a lot of legacy code in this file that could be cleaned up

@javabster javabster moved this to Backlog in Qiskit Sphinx Theme Oct 24, 2022
@javabster javabster changed the title Refactor breadcrumbs.html Review and Refactor breadcrumbs.html Oct 24, 2022
@javabster javabster self-assigned this Oct 24, 2022
@javabster javabster moved this from Backlog to To Do in Qiskit Sphinx Theme Nov 18, 2022
@javabster javabster added this to the v1.11.0 milestone Dec 7, 2022
@javabster javabster moved this from To Do to Backlog in Qiskit Sphinx Theme Feb 9, 2023
@javabster
Copy link
Collaborator Author

Needs discussion: In the breadcrumb component there is a button for viewing the source code on github which currently doesn't really work (it just shows the .rst atm). It would be good to get this GitHub functionality working but my main question is what to do about old versions etc. Should the link always direct to the file in the main branch? Or should it direct to the version of the file corresponding to the version of the docs you are looking at? what about the latest version, should that direct to main or the latest stable version of the file?

@javabster javabster moved this from Backlog to In Review in Qiskit Sphinx Theme Feb 28, 2023
@github-project-automation github-project-automation bot moved this from In Review to Done in Qiskit Sphinx Theme Feb 28, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
No open projects
Status: Done
Development

Successfully merging a pull request may close this issue.

1 participant