Skip to content

Standardize H1 title use in local Markdown docs#2662

Merged
juliusv merged 1 commit intomainfrom
standardize-local-doc-titles
May 28, 2025
Merged

Standardize H1 title use in local Markdown docs#2662
juliusv merged 1 commit intomainfrom
standardize-local-doc-titles

Conversation

@juliusv
Copy link
Member

@juliusv juliusv commented May 28, 2025

See https://groups.google.com/g/prometheus-developers/c/cwL3cM66Em8

In addition, I took the editorial liberty to make slight other modifications to some of the titles, where it seemed necessary. Also had to adjust deeper header levels further into the doc when the page started off with the wrong one.

And I fixed one completely broken list that was close to a title :P

The PR also fixes up the React code to already handle the new titling scheme for local docs outside of the Markdown content.

See https://groups.google.com/g/prometheus-developers/c/cwL3cM66Em8

In addition, I took the editorial liberty to make slight other
modifications to some of the titles, where it seemed necessary. Also had to
adjust deeper header levels further into the doc when the page started off
with the wrong one.

And I fixed one completely broken list that was close to a title :P

The PR also fixes up the React code to already handle the new titling
scheme for local docs outside of the Markdown content.

Signed-off-by: Julius Volz <julius.volz@gmail.com>
@juliusv juliusv requested a review from SuperQ May 28, 2025 15:00
Copy link
Member

@kakkoyun kakkoyun left a comment

Choose a reason for hiding this comment

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

LGTM

@juliusv juliusv merged commit 90377c2 into main May 28, 2025
5 checks passed
@juliusv juliusv deleted the standardize-local-doc-titles branch May 28, 2025 19:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants