Give every docs page its own title, description and H1 - #268
Merged
Conversation
All 17 pages shared the same meta description and had titles built from
section names ("Introduction - SPRUCE documentation"), so none of them
matched what people actually search for.
Each page now carries title/description front matter: unique descriptions
of 99-155 characters, and titles that stay under 60 characters once the
site_name suffix is appended. Headings were rewritten to carry the query
rather than the section name - the comparison page now targets "Cloud
Carbon Footprint alternatives" directly.
site_name is shortened to "SPRUCE" because it is appended to every title,
and site_description now says what the tool ingests.
Zensical derives sidebar labels from the H1, and front matter title
overrides the nav label too, so nav labels are pinned explicitly in
zensical.toml to keep the sidebar readable.
jnioche
added
documentation
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.
All 17 pages shared the same meta description and had titles built from section names ("Introduction - SPRUCE documentation"), so none of them matched what people actually search for.
Each page now carries title/description front matter: unique descriptions of 99-155 characters, and titles that stay under 60 characters once the site_name suffix is appended. Headings were rewritten to carry the query rather than the section name - the comparison page now targets "Cloud Carbon Footprint alternatives" directly.
site_name is shortened to "SPRUCE" because it is appended to every title, and site_description now says what the tool ingests.
Zensical derives sidebar labels from the H1, and front matter title overrides the nav label too, so nav labels are pinned explicitly in zensical.toml to keep the sidebar readable.