Skip to content

"8 sections" is claimed while README.example.md defines 9 markers, one of which renders empty #650

Description

@Jamie-BitFlight

What is wrong

The advertised section count does not match the canonical marker set, and one marker pair has no documented purpose.

  • action.yml's description and package.json both say "8 sections".
  • README.example.md — the file the documentation points to as the complete template — contains 9 start markers: branding, title, badges, description, contents, usage, inputs, outputs, and a ninth, path-parameterised one: <!-- start [.github/ghadocs/examples/] --> / <!-- end [.github/ghadocs/examples/] -->
  • In this repository's own README that ninth pair renders empty, although .github/ghadocs/examples/ contains a markdown file.

No documentation describes what the path-parameterised section does, whether the path is configurable, or what determines its content.

Impact

A user copying the canonical template gets a marker pair that produces nothing, with no way to tell whether it is broken, unsupported, or requires configuration they have not found. The count mismatch also leaves it ambiguous which of the nine is not counted as a section.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Labels

documentationChanges only affect the documentation

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions