Skip to content

DPF: Update headings in changelog-25-r2.md #194

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 2 commits into from
Jul 1, 2025
Merged

DPF: Update headings in changelog-25-r2.md #194

merged 2 commits into from
Jul 1, 2025

Conversation

@PProfizi
Copy link
Contributor

@PProfizi PProfizi commented Jul 1, 2025

No description provided.

@PProfizi PProfizi requested a review from ansys-akarcher July 1, 2025 13:09
@PProfizi PProfizi added this to the 25R2 milestone Jul 1, 2025
@PProfizi PProfizi requested a review from AnsMelanie July 1, 2025 13:10
@PProfizi PProfizi marked this pull request as ready for review July 1, 2025 13:13
@PProfizi PProfizi changed the title Update changelog-25-r2.md Update headings in changelog-25-r2.md Jul 1, 2025
@PProfizi PProfizi changed the title Update headings in changelog-25-r2.md DPF: Update headings in changelog-25-r2.md Jul 1, 2025
AnsMelanie
AnsMelanie reviewed Jul 1, 2025
View reviewed changes
Copy link
Collaborator

@AnsMelanie AnsMelanie left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The title should be changelog for compliance with our guidelines and for a better UX with predictable URLs.

You removed the Detail section? I would have

Details as H2 and then Features as H3

PProfizi
PProfizi commented Jul 1, 2025
View reviewed changes
@PProfizi
Copy link
Contributor Author

PProfizi commented Jul 1, 2025

@AnsMelanie I changed the H1 title.
To me though the Details section seems superfluous. Also as only H2 is shown in the navigation map, people will only be able to go to Details but really they want to navigate to Fixes or Features, so I'd rather keep them as H2.
In the summary this is ok, but having only "Summary" and then "Details" in the navigation pane is not good for me.

@AnsMelanie AnsMelanie merged commit 5ec6321 into main Jul 1, 2025
@PProfizi PProfizi deleted the dpf_25R2/update_changelog_edits branch July 1, 2025 14:26
AnsMelanie added a commit that referenced this pull request Jul 11, 2025
@AnsMelanie
Merge pull request #194 from ansys/dpf_25R2/update_changelog_edits
feeb99a 
DPF: Update headings in changelog-25-r2.md
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@AnsMelanie AnsMelanie AnsMelanie approved these changes

@ansys-akarcher ansys-akarcher Awaiting requested review from ansys-akarcher

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

25R2

Development

Successfully merging this pull request may close these issues.

3 participants

@PProfizi @AnsMelanie