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 caption headers to site table of contents #318

Merged
merged 2 commits into from
Jul 14, 2023

Conversation

Eric-Arellano
Copy link
Contributor

@Eric-Arellano Eric-Arellano commented Jul 12, 2023

This keeps the same order of docs, but adds section headers so it's more obvious what is what.

It also adds a page to <self> so that you can go back to the home page.

Before:

Screenshot 2023-07-12 at 10 24 47 AM

After:

Screenshot 2023-07-14 at 9 54 02 AM

@Eric-Arellano Eric-Arellano changed the title [wip] Better organize site table of contents Better organize site table of contents Jul 12, 2023
@garrison
Copy link
Member

I'm open to this, but it's bit unfortunate that the API references would then come before the tutorials, explanation, and how-to guides.

@caleb-johnson
Copy link
Collaborator

caleb-johnson commented Jul 12, 2023

I'm open to this, but it's bit unfortunate that the API references would then come before the tutorials, explanation, and how-to guides.

I'm normally going straight to API when I go to various packages' docs, so maybe not strictly unfortunate. Also, the API contains info on all the tools, so I don't think it's so bad up there with the CKT blurb and Installation

It's funny you mention this, because I had thought the API at the very bottom was strange before

@Eric-Arellano
Copy link
Contributor Author

I'm happy with whatever order you all think makes sense! And feel free to push commits directly to this branch.

caleb-johnson
caleb-johnson previously approved these changes Jul 12, 2023
@caleb-johnson
Copy link
Collaborator

I'll approve and let @garrison make final call on order and merge

@Eric-Arellano
Copy link
Contributor Author

Eric-Arellano commented Jul 13, 2023

@garrison, one option is to have a 3rd category group called API and then it has the entry underneath called API References. I like that because API is huge when expanded. So when expanded, you avoid covering the rest of the ToC entries. Wdyt?

I'm not sure where Release Notes would go?

@coveralls
Copy link

Pull Request Test Coverage Report for Build 5555862224

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage remained the same at 90.713%

Totals Coverage Status
Change from base Build 5532982717: 0.0%
Covered Lines: 2559
Relevant Lines: 2821

💛 - Coveralls

@Eric-Arellano Eric-Arellano changed the title Better organize site table of contents Add caption headers to site table of contents Jul 14, 2023
Copy link
Member

@garrison garrison left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks great, thanks.

@garrison garrison merged commit 84fc560 into Qiskit-Extensions:main Jul 14, 2023
9 checks passed
@Eric-Arellano Eric-Arellano deleted the organize-toc branch July 14, 2023 17:24
garrison pushed a commit that referenced this pull request Jul 17, 2023
* Better organize site table of contents

* Review feedback: references section
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants