fix(extension): remove frontmatter from README and exclude from markdown linting by Copilot · Pull Request #223 · microsoft/hve-core

Copilot · 2026-01-21T08:34:34Z

YAML frontmatter in extension/README.md renders as raw text on VS Code Marketplace and extension details pages, displaying metadata fields instead of content.

Changes

Removed YAML frontmatter block from extension/README.md (lines 1-12)
- Replaced with H1 heading to maintain proper document structure
- Frontmatter serves no functional purpose—VS Code uses package.json for extension metadata
- Extension packaging workflow copies README as-is; does not parse or use frontmatter
Added extension/README.md to .markdownlint-cli2.jsonc ignores array
- Prevents markdown linting from enforcing rules on extension README
- Markdown linter (MD025/MD041) and frontmatter validation script both support files with or without frontmatter

Before/After

Before:

---
title: HVE Core Extension
description: VS Code extension packaging documentation...
ms.date: 2025-06-23
keywords:
  - vscode extension
---

> AI-powered chat agents, prompts...

After:

# HVE Core Extension

> AI-powered chat agents, prompts, and instructions for hybrid virtual environments

HVE Core provides...

Marketplace now displays content immediately without metadata clutter.

Original prompt

This section details on the original issue you should resolve

<issue_title>[Issue]: Extension README.MD uses frontmatter causing extension details page to look funny outside of repo</issue_title>
<issue_description>### Issue Description

While we test the Pre-Release version of the extension, we notice that the usage of a frontmatter section on the ./extension/README.md file is causing display issues on the marketplace and VS Code extension view pages. We need to remove the frontmatter from this page, and potentially ensure there is an exception for the frontmatter requirement for README.md page in the extension folder.

Header display on marketplace:

Additional Context

See the UI display on https://marketplace.visualstudio.com/items?itemName=ise-hve-essentials.hve-core</issue_description>

<agent_instructions>Before making the change and removing the front-matter, evaluate the impact on our build/CI, and any other checks that may cause issues. Document and then let me decide how to go forward.</agent_instructions>

Comments on the Issue (you are @copilot in this section)

Fixes [Issue]: Extension README.MD uses frontmatter causing extension details page to look funny outside of repo #222

💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

katriendg · 2026-01-21T08:57:02Z

@copilot implement these changes:

Update .markdownlint-cli2.jsonc so that "extension/README.md" is added to the "ignores" array
Remove the frontmatter from the file extension/README.md

…rkdown linting - Remove YAML frontmatter block (lines 1-12) from extension/README.md - Add extension/README.md to .markdownlint-cli2.jsonc ignores array - Replace frontmatter with H1 heading to maintain proper document structure Co-authored-by: katriendg <838216+katriendg@users.noreply.github.com>

Copilot · 2026-01-21T08:59:41Z

@copilot implement these changes:

Update .markdownlint-cli2.jsonc so that "extension/README.md" is added to the "ignores" array

Remove the frontmatter from the file extension/README.md

Implemented both changes in commit 520468c:

✅ Added "extension/README.md" to .markdownlint-cli2.jsonc ignores array
✅ Removed frontmatter (lines 1-12) from extension/README.md and replaced with H1 heading

Before:

---
title: HVE Core Extension
description: VS Code extension packaging documentation...
ms.date: 2025-06-23
keywords:
  - vscode extension
  - packaging
  - copilot customizations
estimated_reading_time: 3
---

> AI-powered chat agents, prompts...

After:

# HVE Core Extension

> AI-powered chat agents, prompts, and instructions for hybrid virtual environments

All validation checks pass (markdown linting, frontmatter validation, CI/CD compatibility).

katriendg

This looks good

github-actions · 2026-01-21T09:16:44Z

Dependency Review

✅ No vulnerabilities or license issues or OpenSSF Scorecard issues found.

Scanned Files

None

Copilot

Pull request overview

This PR fixes a display issue where YAML frontmatter in the extension README was rendering as raw text on the VS Code Marketplace and extension details pages. The fix removes the non-functional frontmatter and adds an H1 heading, while excluding the extension README from markdown linting enforcement.

Changes:

Removed YAML frontmatter block from extension/README.md and replaced with H1 heading
Added extension/README.md to .markdownlint-cli2.jsonc ignores array to prevent linting enforcement

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.

File	Description
extension/README.md	Removed 11 lines of YAML frontmatter (title, description, metadata) and replaced with H1 heading "# HVE Core Extension" for proper Marketplace display
.markdownlint-cli2.jsonc	Added extension/README.md to ignores array to exclude it from markdown linting rules that would require frontmatter

🤖 I have created a release *beep* *boop* --- ## [2.0.0](hve-core-v1.1.0...hve-core-v2.0.0) (2026-01-28) ### ⚠ BREAKING CHANGES * **agents:** add Task Reviewer and expand RPI to 4-phase workflow ([#277](#277)) ### ✨ Features * **agents:** add hve-core-installer agent to extension package ([#297](#297)) ([c0e48c6](c0e48c6)) * **agents:** add Task Reviewer and expand RPI to 4-phase workflow ([#277](#277)) ([ae76cab](ae76cab)) * **build:** add code coverage reporting to Pester workflow ([#230](#230)) ([a34822a](a34822a)) * **docs:** add GOVERNANCE.md for OSSF Silver Badge compliance ([#235](#235)) ([b0e752c](b0e752c)) * **docs:** add ROADMAP.md for OSSF Silver badge compliance ([#238](#238)) ([4a41c16](4a41c16)) * **mcp:** add MCP server configuration guidance and installer enhancements ([#225](#225)) ([0bce418](0bce418)) * **scripts:** add YAML linting with actionlint ([#234](#234)) ([d9301f9](d9301f9)) * **security:** add OpenSSF Scorecard workflow and badge ([#271](#271)) ([7c6d788](7c6d788)) * **skills:** add video-to-gif conversion skill with FFmpeg two-pass optimization ([#247](#247)) ([8d65c42](8d65c42)) * **tests:** add Pester tests for LintingHelpers and Validate-MarkdownFrontmatter ([#197](#197), [#198](#198)) ([#205](#205)) ([51ae563](51ae563)) ### 🐛 Bug Fixes * **build:** detect table formatting changes via git diff ([#261](#261)) ([985eee0](985eee0)) * **build:** disable MD024 lint rule in CHANGELOG for release-please ([#220](#220)) ([971df94](971df94)) * **build:** quote shell variables and group redirects in workflow files ([#299](#299)) ([3372509](3372509)) * **build:** resolve scorecard badge and workflow security issues ([#301](#301)) ([aeaed13](aeaed13)) * **extension:** remove frontmatter from README and exclude from markdown linting ([#223](#223)) ([4272529](4272529)) * **instructions:** quote applyTo glob pattern for YAML compatibility ([#216](#216)) ([085199c](085199c)) * **scripts:** add FooterExcludePaths parameter to frontmatter validation ([#334](#334)) ([64db98d](64db98d)) * **scripts:** add GHSA word and logs/ exclusion to cspell config ([#214](#214)) ([5c99b3f](5c99b3f)) * **scripts:** correct type assertions in Invoke-YamlLint.Tests.ps1 ([#332](#332)) ([af7050d](af7050d)) * **scripts:** eliminate false positives in dependency pinning npm pattern ([#273](#273)) ([ccbdfa3](ccbdfa3)) * **security:** add artifact attestation for signed releases ([#257](#257)) ([c52d6e2](c52d6e2)) * standardize markdown footers and complete frontmatter ([#217](#217)) ([b4e7556](b4e7556)) ### 📚 Documentation * add OpenSSF Best Practices Passing badge to README ([#239](#239)) ([91bc529](91bc529)) * **architecture:** add architecture documentation and value proposition ([#252](#252)) ([0e4b02f](0e4b02f)) * **contributing:** add testing requirements for OSSF compliance ([#254](#254)) ([4db1a18](4db1a18)) * **docs:** add enterprise status badges to README header ([#270](#270)) ([ccb68a4](ccb68a4)) * **security:** add security assurance case and threat model for OSSF Silver ([#259](#259)) ([a390e26](a390e26)) ### ♻️ Refactoring * **application:** wrap execution with try blocks, ensure proper … ([#296](#296)) ([35c4417](35c4417)) * **scripts:** extract frontmatter validation to testable module ([#293](#293)) ([4e8707e](4e8707e)) * **scripts:** extract pure functions for Pester testability ([#221](#221)) ([d40e742](d40e742)) ### 🔧 Maintenance * **deps-dev:** bump cspell from 9.4.0 to 9.6.0 in the npm-dependencies group ([#208](#208)) ([855914b](855914b)) * **deps-dev:** bump cspell from 9.6.0 to 9.6.1 in the npm-dependencies group ([#294](#294)) ([1e45ad6](1e45ad6)) * **deps:** bump actions/setup-node from 6.1.0 to 6.2.0 in the github-actions group ([#209](#209)) ([c4c69e2](c4c69e2)) * **deps:** bump the github-actions group with 4 updates ([#295](#295)) ([d8337b8](d8337b8)) * remove step-security/harden-runner from workflows ([#246](#246)) ([c5708d8](c5708d8)) --- This PR was generated with [Release Please](https://github.com/googleapis/release-please). See [documentation](https://github.com/googleapis/release-please#release-please). Co-authored-by: hve-core-release-please[bot] <254602402+hve-core-release-please[bot]@users.noreply.github.com>

Initial plan

1603598

Copilot AI assigned Copilot and katriendg Jan 21, 2026

Copilot started work on behalf of katriendg January 21, 2026 08:35 View session

Copilot AI changed the title ~~[WIP] Remove frontmatter from extension README.md~~ fix(extension): remove frontmatter from README causing marketplace display issues Jan 21, 2026

Copilot finished work on behalf of katriendg January 21, 2026 08:40

Copilot AI requested a review from katriendg January 21, 2026 08:40

Copilot started work on behalf of katriendg January 21, 2026 08:57 View session

Copilot AI changed the title ~~fix(extension): remove frontmatter from README causing marketplace display issues~~ fix(extension): remove frontmatter from README and exclude from markdown linting Jan 21, 2026

Copilot finished work on behalf of katriendg January 21, 2026 09:00

katriendg approved these changes Jan 21, 2026

View reviewed changes

katriendg marked this pull request as ready for review January 21, 2026 09:58

katriendg requested a review from a team as a code owner January 21, 2026 09:58

Copilot AI review requested due to automatic review settings January 21, 2026 09:58

Copilot started reviewing on behalf of katriendg January 21, 2026 09:58 View session

Copilot AI reviewed Jan 21, 2026

View reviewed changes

bindsi approved these changes Jan 21, 2026

View reviewed changes

Merge branch 'main' into copilot/remove-frontmatter-readme

2666da6

WilliamBerryiii merged commit 4272529 into main Jan 21, 2026
15 checks passed

WilliamBerryiii deleted the copilot/remove-frontmatter-readme branch January 21, 2026 17:42

hve-core-release-please bot mentioned this pull request Jan 21, 2026

chore(main): release hve-core 2.0.0 #212

Merged

This was referenced Jan 28, 2026

chore(main): release hve-core 3.0.0 #341

Closed

chore(main): release hve-core 3.0.0 #417

Closed

This was referenced Feb 6, 2026

chore(main): release hve-core 3.0.0 #441

Closed

chore(main): release hve-core 3.0.0 #530

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix(extension): remove frontmatter from README and exclude from markdown linting#223

fix(extension): remove frontmatter from README and exclude from markdown linting#223
WilliamBerryiii merged 3 commits intomainfrom
copilot/remove-frontmatter-readme

Copilot AI commented Jan 21, 2026 •

edited

Loading

Uh oh!

katriendg commented Jan 21, 2026

Uh oh!

Copilot AI commented Jan 21, 2026

Uh oh!

katriendg left a comment

Uh oh!

github-actions bot commented Jan 21, 2026 •

edited

Loading

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

Conversation

Copilot AI commented Jan 21, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Changes

Before/After

Additional Context

Comments on the Issue (you are @copilot in this section)

Uh oh!

katriendg commented Jan 21, 2026

Uh oh!

Copilot AI commented Jan 21, 2026

Uh oh!

katriendg left a comment

Choose a reason for hiding this comment

Uh oh!

github-actions bot commented Jan 21, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Dependency Review

Scanned Files

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

Copilot AI commented Jan 21, 2026 •

edited

Loading

github-actions bot commented Jan 21, 2026 •

edited

Loading