Skip to content

doc: improve release notes  #64169

Closed
Closed
@jba

Description

@jba

This issue covers a set of improvements to the Go release notes:

  • Convert existing release notes from HTML to Markdown.
  • Change definition lists to level 4 headings.
  • Check that there is a valid release note fragment for each file in api/next.
  • Write a command that prints a report for incomplete release note fragments.
  • Have that command check that there is a release note for an issue if there is a commit that mentions the issue.
  • Write a command to merge release note fragments into a single file.
  • Handle standard library symbol references in release note fragments like the go/doc/comment package would.

Metadata

Metadata

Assignees

Labels

DocumentationIssues describing a change to documentation.NeedsFixThe path to resolution is known, but the work has not been done.early-in-cycleA change that should be done early in the 3 month dev cycle.

Type

No type

Projects

No projects

Milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions