Make all heading levels consistent #1080
Open
Conversation
This file contains 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
|
Concept ACK Seems like you should also specify this requirement in the CONTRIBUTING.md Also this is the type of thing you probably need a GitHub workflow to enforce, it's hard to review PR's at a glance and ensure they meet this requirement |
Thanks, @ProofOfKeags , good ideas. I will look into it. |
jirijakes
force-pushed
the
consistent-headings
branch
from
a59746d to
8c9d4a5
Compare
|
Changes:
|
ProofOfKeags
approved these changes
Mar 7, 2024
jirijakes
force-pushed
the
consistent-headings
branch
from
c1f8a9d to
cc542cc
Compare
|
Rebased. Linter run: https://github.com/jirijakes/bolts/actions/runs/9318710058/job/25651599958 |
jirijakes
force-pushed
the
consistent-headings
branch
from
cc542cc to
d2c96d9
Compare
Previously, levels of headings were used inconsistently across the documents, which made automated export to other formats complicated. With this change, all documents have single level 1 heading (title of the document) and all other headings are at least level 2.
Commit introduces initial set of rules for checking formatting of markdown files as part of GitHub workflow. The rules are: - first line is top-level heading - there is only one top-level heading in the document
jirijakes
force-pushed
the
consistent-headings
branch
from
d2c96d9 to
76859f5
Compare
|
Rebased and included BOLT12. Linter run: https://github.com/jirijakes/bolts/actions/runs/11215057123/job/31171445815 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
With this change, all documents have a single level-1 heading (document title), all other headings are at least level 2.
Additionally, linter is introduced to enforce the heading consistency.
Rationale
I wish to export documents to other formats (using pandoc). Unfortunately, levels of headings were used inconsistently across the documents, which made automated export quite complicated. This change makes all headings consistent with 00-introduction.md and 01-messaging.md.
Headings were shifted down by one level, a few did not require any change. Links to sections remain the same, therefore no references to the bolts and their sections should be broken.