-
Notifications
You must be signed in to change notification settings - Fork 125
Closed
Labels
bugSomething isn't workingSomething isn't workingdocumentationImprovements or additions to documentationImprovements or additions to documentationgood first issueGood for newcomersGood for newcomers
Description
Summary
The BRD template file has a YAML syntax error in its frontmatter that causes npm run lint:frontmatter to fail.
Problem
File: docs/templates/brd-template.md
Error: Invalid YAML syntax: Exception calling "Load" with "1" argument(s): "Block sequence entries are not allowed in this context."
Root Cause
The frontmatter contains unquoted values with - (space-hyphen-space), which YAML interprets as a block sequence indicator:
---
title: {{initiativeName}} - Business Requirements Document
description: Business requirements for {{briefDescription}}
author: {{authorName}}
ms.date: 2025-12-05
ms.topic: reference
---Solution
Quote the frontmatter values that contain special characters:
---
title: "{{initiativeName}} - Business Requirements Document"
description: "Business requirements for {{briefDescription}}"
author: "{{authorName}}"
ms.date: 2025-12-05
ms.topic: reference
---Acceptance Criteria
-
npm run lint:frontmatterpasses with 0 errors for this file - Template remains functional for BRD generation workflows
Good First Issue
This is a straightforward single-file fix suitable for new contributors.
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
bugSomething isn't workingSomething isn't workingdocumentationImprovements or additions to documentationImprovements or additions to documentationgood first issueGood for newcomersGood for newcomers