Skip to content

Clean up release pages #patch#129

Merged
asteiner-swisstopo merged 1 commit intomasterfrom
clean-up-data-update-pages
Mar 23, 2026
Merged

Clean up release pages #patch#129
asteiner-swisstopo merged 1 commit intomasterfrom
clean-up-data-update-pages

Conversation

@asteiner-swisstopo
Copy link
Copy Markdown
Contributor

@asteiner-swisstopo asteiner-swisstopo commented Mar 19, 2026

This is a follow-up of a PR comment regarding a change by @ltshb.

I have noticed that all release pages follow this structure:

# Release title

### API & applications

### API

- Bug fixes:
- Announcements:
  - Announcement 1
  - Announcement 2

- [Full changelog][https://link]

### Geodata

In an example:

image

I see three issues with that:

  1. Inconsistent formatting: The heading levels jump from h1 (#) directly to h3 (###). Proper markdown does not skip heading levels.
  2. "API & applications": Empty on all pages, not clear what is its purpose.
  3. "Bug fixes:": It's empty for all pages except 20250514. Removing it along with the "Announcements" reduces the list nesting.

To focus on the content, I propose to simplify the structure to this:

# Release title

## API

- Announcement 1
- Announcement 2
- [Full changelog][https://link]

## Geodata

The change in heading levels also requires changing the script for the "All releases" page.

Test link

This is a follow-up of [a PR comment](#128 (comment)).

I have noticed that all release pages follow this structure:

```txt
\# Release title

\### API & applications

\### API

- Bug fixes
- Announcements:
  - Announcement 1
  - Announcement 2

- [Full changelog][https://link]

\### Geodata
```

I see three issues with that:

1. Inconsistent formatting: The heading levels jump from h1 (#) directly to h3 (###). Proper markdown does not skip heading levels.
2. "API & applications": Empty on all pages, not clear what is its purpose.
3. "Bug fixes": It's empty for all pages except 20250514. Removing it along with the "Announcements" reduces the list nesting.

To focus on the content, I propose to simplify the structure to this:

```txt
\# Release title

\## API
- Announcement 1
- Announcement 2
- [Full changelog][https://link]

\## Geodata
```

The change in heading levels also requires changing the script for the "All releases" page.
Copy link
Copy Markdown
Contributor

@rebert rebert left a comment

Choose a reason for hiding this comment

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

ok

@asteiner-swisstopo asteiner-swisstopo changed the title Clean up release pages Clean up release pages #patch Mar 23, 2026
@asteiner-swisstopo asteiner-swisstopo merged commit 60d2e00 into master Mar 23, 2026
3 of 4 checks passed
@asteiner-swisstopo asteiner-swisstopo deleted the clean-up-data-update-pages branch March 23, 2026 10:05
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.

3 participants