-
Notifications
You must be signed in to change notification settings - Fork 25
Description
Issue Description
A comprehensive audit of the repository's 97 markdown files identified inconsistencies in footer formats and gaps in frontmatter metadata. Standardizing these elements will improve documentation quality, maintainability, and compliance with repository conventions.
Summary of Findings
| Category | Count | Impact |
|---|---|---|
| Files missing footers entirely | 2 | High |
| Files with inconsistent footer format | 12+ | Medium |
| Files using alternate attribution | 8 | Medium |
| Files missing recommended frontmatter fields | 7+ | Low |
Priority 1: Missing Footers (High)
The following files have no footer attribution:
docs/contributing/release-process.mdextension/PACKAGING.md
Expected footer format:
<!-- markdownlint-disable MD036 -->
*Crafted with precision by GitHub Copilot*
<!-- markdownlint-enable MD036 -->Priority 2: Inconsistent Footer Formats (Medium)
Multiple files have footers but with format variations:
Missing markdownlint comments and italic markers
| File | Current Footer |
|---|---|
docs/getting-started/README.md |
Crafted with precision by Copilot |
docs/getting-started/first-workflow.md |
Crafted with precision by Copilot |
docs/getting-started/install.md |
Crafted with precision by Copilot |
docs/getting-started/methods/*.md (7 files) |
Crafted with precision by Copilot |
.github/chatmodes/README.md |
Crafted with precision by Copilot |
.github/workflows/README.md |
Crafted with precision by Copilot |
scripts/README.md |
Crafted with precision by Copilot |
scripts/linting/README.md |
Crafted with precision by Copilot |
Issues:
- Missing
<!-- markdownlint-disable MD036 -->and enable comments - Missing italic markers (
*...*) - Using "Copilot" instead of "GitHub Copilot"
Priority 3: Alternate Attribution Format (Medium)
Some files use "Brought to you by" format instead of standard footer:
| File | Current Footer |
|---|---|
docs/contributing/ai-artifacts-common.md |
"Brought to you by microsoft/hve-core" |
docs/contributing/chatmodes.md |
"Brought to you by microsoft/hve-core" |
docs/contributing/instructions.md |
"Brought to you by microsoft/hve-core" |
docs/contributing/prompts.md |
"Brought to you by microsoft/hve-core" |
docs/templates/brd-template.md |
"Brought to you by microsoft/hve-core" |
extension/README.md |
"Brought to you by Microsoft ISE HVE Essentials" |
Decision needed: Should these be converted to standard format or is this an intentional distinction?
Priority 4: RPI Documentation Format
The RPI docs use a unique format that may be intentional:
| File | Current Footer |
|---|---|
docs/rpi/*.md (5 files) |
🤖 *Crafted with precision by ✨Copilot using the RPI workflow* |
Decision needed: Should RPI docs maintain their distinctive format?
Priority 5: Missing Frontmatter Fields (Low)
Per schema validation, the following recommended fields are often missing:
authorms.datems.topickeywordsestimated_reading_time
Notable: extension/README.md has no frontmatter at all.
Acceptance Criteria
- All markdown files have consistent footer format
- All footers include proper markdownlint disable/enable comments
- All footers use italic markers for the attribution text
- All footers reference "GitHub Copilot" (if standardized)
- Decision documented for alternate formats (RPI, "Brought to you by")
-
extension/README.mdhas valid frontmatter
Additional Context
Standard Footer Format
<!-- markdownlint-disable MD036 -->
*Crafted with precision by GitHub Copilot*
<!-- markdownlint-enable MD036 -->Files with Correct Format (for reference)
The following files have the correct standard format:
CONTRIBUTING.mdSECURITY.mdSUPPORT.mdCODE_OF_CONDUCT.mddocs/contributing/README.mddocs/contributing/branch-protection.md
Validation Status
Current frontmatter validation (logs/frontmatter-validation-results.json) shows 0 errors across 96 files, indicating all required fields (title, description) are present where schemas require them.