Skip to content

docs: fix misspelled 'descrition' front-matter key and a typo - #5582

Merged
svozza merged 1 commit into
aws-powertools:mainfrom
vaibhav8a:fix-frontmatter-description
Aug 25, 2026
Merged

docs: fix misspelled 'descrition' front-matter key and a typo#5582
svozza merged 1 commit into
aws-powertools:mainfrom
vaibhav8a:fix-frontmatter-description

Conversation

@vaibhav8a

@vaibhav8a vaibhav8a commented Aug 25, 2026

Copy link
Copy Markdown
Contributor

Summary

Changes

Three feature docs pages open with a misspelled front-matter key:

---
title: Parser
descrition: Utility
---

descrition is not a key MkDocs recognises, and 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, docs/features/parser.md, docs/features/signer.md and docs/features/validation.md are 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.md line 92: "It's recommended to pass a refernce" → reference.

Docs only — no source, tests or public API are touched.

Please add the issue number below, if no issue is present the PR might get blocked and not be reviewed

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.

@svozza

svozza commented Aug 25, 2026

Copy link
Copy Markdown
Contributor

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 create-issue and create-pr skills.

@vaibhav8a

Copy link
Copy Markdown
Contributor Author

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 <meta name="description"> at all, however you choose to fix it.

@svozza

svozza commented Aug 25, 2026

Copy link
Copy Markdown
Contributor

LGTM. Merging!

@svozza
svozza merged commit 12ce144 into aws-powertools:main Aug 25, 2026
40 checks passed
@powertools-for-aws-oss-automation

Copy link
Copy Markdown

Awesome work, congrats on your first merged pull request and thank you for helping improve everyone's experience!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

size/XS PR between 0-9 LOC

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Docs: three feature pages publish no description metadata (misspelled front-matter key)

2 participants