Skip to content

Cleanup: README.md contains leftover scratch text "no-op documentation tweak" #429

@kevinelliott

Description

@kevinelliott

Summary

The published README.md opens with a stray paragraph that looks like leftover scratch text from a workflow-verification PR, sitting awkwardly between the "Node.js Support Policy" section and the actual project header:

# @airframes/acars-decoder

This is a no-op documentation tweak to verify repository access, build/lint, tests, and PR workflow. No functional code changes are included.

# acars-decoder-typescript

This is the README that ships on the package's npm and GitHub pages, so it's reader-facing. The two competing top-level headers (# @airframes/acars-decoder and # acars-decoder-typescript) also make the document structure confusing.

Suggested fix

  • Delete the "no-op documentation tweak" sentence and the duplicate # @airframes/acars-decoder heading.
  • Optionally move the "Node.js Support Policy" section below the project header / badges so the README opens with the project name.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    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