What were you searching in the docs?
I was reading the Parser, Signer and Validation feature pages. Rather than a search that came up empty, this is something I noticed about how those three pages are published: they carry no description metadata, while every other feature page does.
Is this related to an existing documentation section?
How can we improve?
docs/features/parser.md, docs/features/signer.md and docs/features/validation.md each open with a misspelled front-matter key:
---
title: Parser
descrition: Utility
---
descrition is not a key MkDocs recognises. Every other feature page uses description: — logger.md, tracer.md and metrics.md all read description: Core utility.
The effect is not cosmetic: because the key never resolves, those three pages are published with no description metadata at all, so the <meta name="description"> tag falls back to the site default. That is what search engines and link previews read, so the three pages are less discoverable and preview less usefully than their siblings.
Separately, docs/features/event-handler/appsync-graphql.md line 92 reads "It's recommended to pass a refernce" — a plain typo in prose.
Got a suggestion in mind?
Correct the key to description: on all three pages, leaving the values as they are, and fix the refernce typo.
I have a PR open with exactly that change: #5582. Happy for it to be closed if you would rather take a different approach — I opened it before reading that this project prefers issue-first, and this issue is the tracking artefact @svozza asked for.
Acknowledgment
What were you searching in the docs?
I was reading the Parser, Signer and Validation feature pages. Rather than a search that came up empty, this is something I noticed about how those three pages are published: they carry no description metadata, while every other feature page does.
Is this related to an existing documentation section?
How can we improve?
docs/features/parser.md,docs/features/signer.mdanddocs/features/validation.mdeach open with a misspelled front-matter key:descritionis not a key MkDocs recognises. Every other feature page usesdescription:—logger.md,tracer.mdandmetrics.mdall readdescription: Core utility.The effect is not cosmetic: because the key never resolves, those three pages are published with no description metadata at all, so the
<meta name="description">tag falls back to the site default. That is what search engines and link previews read, so the three pages are less discoverable and preview less usefully than their siblings.Separately,
docs/features/event-handler/appsync-graphql.mdline 92 reads "It's recommended to pass a refernce" — a plain typo in prose.Got a suggestion in mind?
Correct the key to
description:on all three pages, leaving the values as they are, and fix thereferncetypo.I have a PR open with exactly that change: #5582. Happy for it to be closed if you would rather take a different approach — I opened it before reading that this project prefers issue-first, and this issue is the tracking artefact @svozza asked for.
Acknowledgment