Skip to content

Problem: wrong semantic in spec format #111

@angelicawill

Description

@angelicawill

The spec format example in docs/CONTRIBUTING.md shows specs starting with _Goal:_ metadata and going straight to ## Overview — no H1

h2 goes without h1?

use rumdl, it will fix it all automatically

Originally posted by @zolotokrylin in https://github.com/holdex/marketing-website/pull/1033#discussion_r3172204494

Solution

Pick one of the two:

Option A — add a # Feature Name H1 to the format example. The H1 sits between the _Goal:_ metadata and ## Overview. Matches what every existing spec already does (# Case Studies Pages in markdown-pages.md, # Article Discoverability in article-discoverability.md). One H1 per file, then H2 sections — standard markdown structure.

_Goal: _

# Feature Name

## Overview
...

Option B — promote the existing ## headings to #.

_Goal: _

# Overview
...

# [Section]
...

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels
    No fields configured for Problem.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions