docs: fix misspelled 'descrition' front-matter key and a typo - #5582
Conversation
|
Hi there, thank you for the PR. Can you please create an accompanying GitHub issue for this pull request? Ideally we prefer these to be created before any PR. Please see step 3 in the contributing guide: https://github.com/aws-powertools/powertools-lambda-typescript/blob/main/CONTRIBUTING.md#contributing-via-pull-requests. Also, can you update the PR body to use the template we have? If you are using a coding agent, just ask it to invoke the |
|
Thanks @svozza — both done.
Understood that a PR against a non-triaged issue may not go anywhere. Happy to wait on triage, and equally happy for this to be closed if you'd rather handle the front-matter differently — the substance is that those three pages currently publish no |
|
LGTM. Merging! |
|
Awesome work, congrats on your first merged pull request and thank you for helping improve everyone's experience! |
Summary
Changes
Three feature docs pages open with a misspelled front-matter key:
descritionis not a key MkDocs recognises, and every other feature page usesdescription:—logger.md,tracer.mdandmetrics.mdall readdescription: Core utility.The effect is not cosmetic. Because the key never resolves,
docs/features/parser.md,docs/features/signer.mdanddocs/features/validation.mdare published with no description metadata at all, so<meta name="description">falls back to the site default. That is what search engines and link previews read, so those three pages are less discoverable than their siblings.This corrects the key to
description:on all three, leaving the values untouched.It also fixes a plain prose typo in
docs/features/event-handler/appsync-graphql.mdline 92: "It's recommended to pass a refernce" →reference.Docs only — no source, tests or public API are touched.
Issue number: closes #5583
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.