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

Copilot · katriendg · WilliamBerryiii · web-flow · commit 427252962228 · 2026-01-21T09:42:51.000-08:00
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:** ```markdown --- title: HVE Core Extension description: VS Code extension packaging documentation... ms.date: 2025-06-23 keywords: - vscode extension --- > AI-powered chat agents, prompts... ``` **After:** ```markdown # 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.  <details> <summary>Original prompt</summary> > > ---- > > *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. > > <img width="2314" height="1879" alt="Image" src="https://github.com/user-attachments/assets/5c46223d-e9ca-4e9c-9799-6cf07df68aa7" /> > > Header display on marketplace: > > <img width="1563" height="1133" alt="Image" src="https://github.com/user-attachments/assets/83939efe-1459-4da4-90ae-47e140e79755" /> > > ### 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) > > <comments> > </comments> > </details>  - Fixes #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](https://gh.io/copilot-coding-agent-tips) in the docs. --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: katriendg <838216+katriendg@users.noreply.github.com> Co-authored-by: Bill Berry <WilliamBerryiii@users.noreply.github.com>
diff --git a/.markdownlint-cli2.jsonc b/.markdownlint-cli2.jsonc
@@ -4,6 +4,7 @@
     "**/packages/**",
     ".copilot-tracking/**",
     "venv/**",
-    "scripts/tests/Fixtures/**"
+    "scripts/tests/Fixtures/**",
+    "extension/README.md"
   ]
 }
diff --git a/extension/README.md b/extension/README.md
@@ -1,15 +1,4 @@
----
-title: HVE Core Extension
-description: VS Code extension packaging documentation for HVE Core Copilot customizations
-author: Microsoft
-ms.date: 2025-06-23
-ms.topic: reference
-keywords:
-  - vscode extension
-  - packaging
-  - copilot customizations
-estimated_reading_time: 3
----
+# HVE Core Extension
 
 > AI-powered chat agents, prompts, and instructions for hybrid virtual environments
 

Original file line number	Diff line number	Diff line change
`@@ -4,6 +4,7 @@`
`4`	`4`	`"/packages/",`
`5`	`5`	`".copilot-tracking/**",`
`6`	`6`	`"venv/**",`
`7`		`- "scripts/tests/Fixtures/**"`
	`7`	`+ "scripts/tests/Fixtures/**",`
	`8`	`+ "extension/README.md"`
`8`	`9`	`]`
`9`	`10`	`}`