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

Improve header hierarchy for API module pages (backport #12325) #12350

Merged
merged 1 commit into from
May 9, 2024

Conversation

mergify[bot]
Copy link
Contributor

@mergify mergify bot commented May 6, 2024

Closes Qiskit/documentation#942. This uses a few principles:

  • There should never be more than one h1, as it violates web best practices.
  • Functions, classes, and exceptions should always be preceded by at least an h2
    • Why? The docs app generates a header for functions/classes/exceptions, which is important for a) anchor links, b) search, and c) the right page table of contents. But the header will always be an h3 or lower (like h4). It's a semantic violation to go from h1 to h3 - you are supposed to have an intermediate header
  • Flatten headers when possible
    • The docs app only shows h2 and h3 in the right page ToC, and it will always be that way because showing h4s makes things too noisy when we experimented. There are a few instances where content is meaningful enough it should show up in the page ToC
    • There were a few instances of multiple headers with only one entry each. This is noisy.
  • Use standard RST convention for headers
    • h1 uses = above and below
    • h2 uses = below
    • h3 uses - below
    • h4 uses ~ below

This is an automatic backport of pull request #12325 done by [Mergify](https://mergify.com).

* Improve header hierarchy for API module pages

* Tweaks

* Review feedback

(cherry picked from commit f39c907)
@mergify mergify bot requested review from eggerdj, wshanks, a team and jyu00 as code owners May 6, 2024 13:51
@qiskit-bot
Copy link
Collaborator

Thank you for opening a new pull request.

Before your PR can be merged it will first need to pass continuous integration tests and be reviewed. Sometimes the review process can be slow, so please be patient.

While you're waiting, please feel free to review other open PRs. While only a subset of people are authorized to approve pull requests for merging, everyone is encouraged to review open pull requests. Doing reviews helps reduce the burden on the core team and helps make the project's code better for everyone.

One or more of the the following people are requested to review this:

  • @Cryoris
  • @Qiskit/terra-core
  • @ajavadia
  • @mtreinish
  • @nkanazawa1989

@github-actions github-actions bot added documentation Something is not clear or an error documentation Changelog: None Do not include in changelog labels May 6, 2024
@github-actions github-actions bot added this to the 1.1.0 milestone May 6, 2024
@coveralls
Copy link

Pull Request Test Coverage Report for Build 8970248533

Details

  • 1 of 1 (100.0%) changed or added relevant line in 1 file are covered.
  • 23 unchanged lines in 2 files lost coverage.
  • Overall coverage decreased (-0.03%) to 89.605%

Files with Coverage Reduction New Missed Lines %
crates/qasm2/src/lex.rs 5 92.11%
crates/qasm2/src/parse.rs 18 95.77%
Totals Coverage Status
Change from base Build 8941650954: -0.03%
Covered Lines: 62230
Relevant Lines: 69449

💛 - Coveralls

@Eric-Arellano Eric-Arellano added this pull request to the merge queue May 9, 2024
Merged via the queue into stable/1.1 with commit 2cde2d6 May 9, 2024
18 checks passed
@mergify mergify bot deleted the mergify/bp/stable/1.1/pr-12325 branch May 9, 2024 14:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Changelog: None Do not include in changelog documentation Something is not clear or an error documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants