update notebook convention single h1#1626
Open
classiqdor wants to merge 5 commits into
Open
Conversation
classiqdor
commented
Jun 25, 2026
classiqdor
commented
Contributor
- Use a single H1 per notebook (demote section H1s to H2)
- Normalize heading hierarchy in the single-H1 notebooks
- Normalize heading hierarchy across more main notebooks
- Normalize heading hierarchy in sampled main notebooks
- Normalize heading hierarchy across remaining main notebooks
Each notebook should have exactly one H1 (its title). Demoted the later section-level H1s to H2 across 15 notebooks; in arithmetic_expressions an instructional sentence mis-marked as an H1 became plain prose. Headings inside fenced code blocks were left untouched (they are code comments, not headings) - classiq_chemistry_application and WS_iQuHack_2025_final were flagged only because of such comments and needed no change.
Second pass over the 15 notebooks: fix level skips (e.g. H1->H3, H2->H4) and nesting (sections that were really sub-topics, or sub-topics stranded too deep), changing only heading levels. 6 of the 15 needed changes; the other 9 were already well-structured. Done via the notebook-heading-hierarchy agent; diffs are heading-only.
Heading-hierarchy agent pass over main notebooks with deterministic issues (level skips, missing/duplicate H1): 18 notebooks fixed (9 from the pilot batch + 9 of 10 flagged; vlasov_ampere_qiskit intentionally left without an H1 as a Qiskit-comparison notebook whose title is bold prose). Diffs are heading-level-only.
Heading-hierarchy agent sample over 25 structurally-clean main notebooks (one H1, no skips): 4 had subtle nesting issues a level-skip detector can't see and were fixed (hhl: Generalizations -> H2; fermionic_gaussian: symmetric H3->H4; Qmod_tutorial_part1: false-nested Solution 6a/6b -> H3; synthesis_tutorial: Exercise -> H2). The other 21 were already well-structured.
Full heading-hierarchy agent sweep of the remaining 104 structurally-clean main notebooks. 11 had subtle flatten-vs-nest issues a level-skip detector cannot see and were fixed (e.g. qsvm parallel Example sections, classical_shadow Clifford branch, rectangles_packing '3 steps', grover_graph_coloring oracle nesting). The other 93 were already well-structured. Heading-level-only changes.
|
Check out this pull request on See visual diffs & provide feedback on Jupyter Notebooks. Powered by ReviewNB |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.