Generate uniform <h1> headings for all modules #287
Merged
Conversation
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
In 60e05b5, we began generating default `<h1>` headings for modules. However, these headings were only generated for modules that had a description. If a module had no comment to begin with, it would not get a generated heading. Furthermore, since c17deff, each module's full name has been prominently displayed at the top of its page. These names are visually redundant with generated headings, which also use the full name. To unify the design and ensure that all modules have an `<h1>`, this commit converts each module's full name into an `<h1>` heading inside an `<hgroup>`, and uses postprocessing to pull any comment-based `<h1>` into the `<hgroup>`. This commit also renames the "Included Modules" section to "Inherits From", and moves any listed base class from the top of the page to the top of that section. This change focuses the `<h1>`, both visually and from an SEO perspective.
jonathanhefner
force-pushed
the
h1-unify
branch
from
cf5b68e to
41cd675
Compare
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.
In #223, we began generating default
<h1>headings for modules. However, these headings were only generated for modules that had a description. If a module had no comment to begin with, it would not get a generated heading.Furthermore, since #280, each module's full name has been prominently displayed at the top of its page. These names are visually redundant with generated headings, which also use the full name.
To unify the design and ensure that all modules have an
<h1>, this commit converts each module's full name into an<h1>heading inside an<hgroup>, and uses postprocessing to pull any comment-based<h1>into the<hgroup>.This commit also renames the "Included Modules" section to "Inherits From", and moves any listed base class from the top of the page to the top of that section. This change focuses the
<h1>, both visually and from an SEO perspective.