Skip to content

Generated MD file documentation should follow MD041/first-line-heading/first-line-h1: First line in a file should be a top-level heading #1138

@PaulMEdwards

Description

@PaulMEdwards

I use the markdownlint VSCode extension and it complains about MD041/first-line-heading/first-line-h1: First line in a file should be a top-level heading on all the OpenSpec generated documentation MD files.

It would be ideal to have these headings as the first line, followed by a blank line, in the respective generated files:

File Heading
proposal.md # Proposal
design.md # Design
spec.md # Specifications or # Requirements
tasks.md # Tasks

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions