Skip to content

[CHORE]: keep a changelog format update for GitHub auto indexing #312

@fugerit79

Description

@fugerit79

Module

Changelog

Expected Behavior

We only want the only show versions in GitHub auto indexing

Other information

As stated in :
https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax#headings

Currently all headers are indexed by default on GitHub, we want to switch from header for subsection :

### Changed

To bold :

**Changed**

And the GitHub auto index would change from

Image

to

Image

NOTE : this is to be considered an optional alternate changelog formatting proposal

NOTE : in case the proposal is accpeted maybe a complementary migration guide could be proposed

Metadata

Metadata

Assignees

Labels

No labels
No labels

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions