Update using-yaml-frontmatter.md #39695
Conversation
Title tag is required according to this code: https://github.com/github/docs/blob/f584b8f16867a48d2268deb733acce68484299d4/src/frame/lib/frontmatter.js#L40
|
Thanks for opening this pull request! A GitHub docs team member should be by to give feedback soon. In the meantime, please check out the contributing guidelines. |
There was a problem hiding this comment.
Pull Request Overview
This PR updates the documentation to correctly reflect that the title field in YAML frontmatter is required rather than optional. The change aligns the documentation with the actual code implementation that validates the presence of the title field.
- Updated the
titlefield documentation from "Optional" to "Required"
content/contributing/writing-for-github-docs/using-yaml-frontmatter.md
Outdated
Show resolved
Hide resolved
github-actions
bot
added
the
triage
How to review these changes 👓Thank you for your contribution. To review these changes, choose one of the following options: A Hubber will need to deploy your changes internally to review. Table of review linksNote: Please update the URL for your staging server or codespace. The table shows the files in the
Key: fpt: Free, Pro, Team; ghec: GitHub Enterprise Cloud; ghes: GitHub Enterprise Server 🤖 This comment is automatically generated. |
…atter.md Co-authored-by: Copilot <[email protected]>
|
@vit100-trader Looks good! Thanks for catching that. I'll get this added to the merge queue once checks are passing. |
|
Thanks very much for contributing! Your pull request has been merged 🎉 You should see your changes appear on the site in approximately 24 hours. If you're looking for your next contribution, check out our help wanted issues ⚡ |
Why:
title tag is required according to this code:
docs/src/frame/lib/frontmatter.js
Line 40 in f584b8f
What's being changed (if available, include any code snippets, screenshots, or gifs):
titlefield in YAML frontmatter is now marked as required instead of optional, making it clear that every page must specify a human-friendly title.