Skip to content

fix(docs): give the introduction page a descriptive title, description and H1 - #1315

Merged
BryanFRD merged 2 commits into
mainfrom
docs/intro-seo-title
Oct 16, 2026
Merged

BryanFRD merged 2 commits into
mainfrom
docs/intro-seo-title

Conversation

@BryanFRD

Copy link
Copy Markdown
Contributor

Closes #1314

  • docs-en/introduction.md: title What is FerrFlow? Semantic versioning CLI (rendered as ... : FerrFlow Docs), a description that says what the binary does, and an # What is FerrFlow? heading.
  • docs-fr/introduction.md: the same in French.
  • The page was at position 5.3 with a 0.36% CTR over 279 impressions: well placed and rarely clicked, so the snippet is the lever.
  • The nav label stays Introduction (it comes from DOCS_NAV, not the frontmatter).
  • Frozen snapshots (docs-vN) are untouched.

@ferrfleet ferrfleet Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nothing blocking. Frontmatter is valid, the EN and FR pages match, and the frozen snapshots are untouched.

Nit: the FR strings are long for a search result. With the : FerrFlow Docs suffix the title is about 70 characters and the description about 190, so Google will probably truncate both. If French snippets matter, shorten them, for example Qu'est-ce que FerrFlow ? Versionnage sémantique.

Nit: no other page in docs-en has a Markdown H1, so this one is now the odd one out. I couldn't check the renderer from this repo, so it's worth confirming that the frontmatter title isn't also rendered as an H1, which would give the page two.

@BryanFRD
BryanFRD enabled auto-merge (squash) October 11, 2026 17:45
@BryanFRD
BryanFRD merged commit 3eca867 into main Oct 16, 2026
31 checks passed
@BryanFRD
BryanFRD deleted the docs/intro-seo-title branch October 16, 2026 10:55
ferrflow Bot added a commit that referenced this pull request Oct 16, 2026
## [7.30.3] - 2026-10-16

### Bug Fixes

- fix(docs): give the introduction page a descriptive title, description and H1 (#1315)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

fix(docs): the introduction page has a generic title and no H1

1 participant