feat(docs): added links to github changelog to migration page headers by duvalale · Pull Request #3604 · Orange-OpenSource/Orange-Boosted-Bootstrap

duvalale · 2026-06-12T14:41:26Z

Related issues

Closes #3457

Description

Updated migration page headers to add link redirecting to matching changelog.

Checklists

I have read the contributing guidelines
My change follows the developer guide
My change follows the page structure defined in [OUDS] Create a component page template for the doc #3045
Title and DOM structure is correct
Links have been updated (title change impacts links for example)

Progression (for Core Team only)

Code review
Commit on ouds/main following conventional commit

Live previews

https://deploy-preview-3604--boosted.netlify.app/

netlify · 2026-06-12T14:45:28Z

✅ Deploy Preview for boosted ready!

Name	Link
🔨 Latest commit	`fea4901`
🔍 Latest deploy log	https://app.netlify.com/projects/boosted/deploys/6a58f1b9f7eb500008c42f95
😎 Deploy Preview	https://deploy-preview-3604--boosted.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.
🤖 Make changes	Run an agent on this branch

To edit notification comments on pull requests, go to your Netlify project configuration.

MaxLardenois

I think it'd be better if the changelog link was on a dedicated link or button below the title (or on its right for wider viewports)
Here the link is not easily visible and it lacks an accessible text.

duvalale · 2026-06-19T14:14:29Z

I updated the headers to add a dedicated link.
I had to use a remark and rehype plugins to be able to add the link and position it correctly in the DOM for keyboard navigation, otherwise, the focus order would have been incorrect (anchor-link focused after changelog link).

MaxLardenois

Nice work!
I have some suggestion but nothing blocking so I will approve

MaxLardenois · 2026-06-25T12:38:58Z

 }
+
+// A rehype plugin to reorder header anchor and version links
+export const rehypeHeaderLinksOrder: Plugin<[], Root> = function () {


Maybe we could simplify this by using the option before on rehypeAutolinkHeadings
This way the anchor-link would always be first (before the actual heading text), this would be that less to do.
But it works as is, just an idea.

I tried to keep the existing headers as is on purpose, but it is indeed simpler to move the anchor-link before the actual heading.
I removed the rehypeHeaderLinksOrder and updated the autolink conf.

I kept the existing header as is on purpose, but if I am allowed to update it, it is indeed better to prepend the anchor link.
It's done, and the rehypeHeaderLinksOrder is removed.

Sorry I was not clear: we should keep the end result as is (anchor-link after the heading text). But for this script I think it might be helpful if the anchor-link were always first, so that you only need to spilt the heading elements and reorder everytime, no need to find the anchor-link

Done as you suggested.
However, this does not simplify as much as I thought the function since we also have to manage the component icon displayed on some headings.

Copilot

Pull request overview

Adds “Full changelog” links (with an external-link icon) to version headers in the Migration documentation, and adjusts the Markdown/HTML processing pipeline so heading anchors and generated IDs behave correctly with the new inline link content.

Changes:

Introduces a [[version-changelog-link]] marker and a remark plugin to inject a GitHub release link into version headings.
Updates rehype/markdown integration to change heading autolink behavior and reorder heading children.
Adds an external-link symbol to each brand’s SVG sprite so the injected link can display an icon.

Reviewed changes

Copilot reviewed 6 out of 9 changed files in this pull request and generated 7 comments.

Show a summary per file

File	Description
site/static/sosh/docs/[version]/assets/img/ouds-web-sprite.svg	Adds `external-link` symbol to sprite for Sosh docs.
site/static/orange/docs/[version]/assets/img/ouds-web-sprite.svg	Adds `external-link` symbol to sprite for Orange docs.
site/static/orange-compact/docs/[version]/assets/img/ouds-web-sprite.svg	Adds `external-link` symbol to sprite for Orange Compact docs.
site/src/libs/utils.ts	Adds helpers for generating the version changelog link + heading detection.
site/src/libs/toc.ts	Strips “Full changelog” from heading text when generating ToC entries.
site/src/libs/remark.ts	Adds remark plugin to inject version changelog link HTML into headings.
site/src/libs/rehype.ts	Adds rehype plugins for heading child ordering and heading-id adjustment.
site/src/libs/astro.ts	Wires new remark/rehype plugins into Astro markdown configuration and changes autolink behavior.
site/src/content/docs/getting-started/migration.mdx	Adds the `[[version-changelog-link]]` marker to version headings.

MaxLardenois · 2026-07-09T06:22:27Z

There is two issues in the result :

a single " is present on the changelog link
the icon is not visible

louismaximepiton

I'm fine with the changes, tbh I think we could go through the frontmatter instead of a remark thing since all the title h2 are changed on the page. However, it works like a charm so I'm fine with the changes, if you wanna merge as-is.

louismaximepiton · 2026-07-16T12:55:55Z

 }
+
+export function getVersionLink(version: string): string {
+    return `<a class="link icon-link float-end p-none" href="https://github.com/Orange-OpenSource/Orange-Boosted-Bootstrap/releases/tag/${version}-ouds-web" target="_blank" rel="noopener">


Not a big fan of using float-end, but can't figure out how to achieve the smae thing in a different way.

louismaximepiton · 2026-07-16T13:22:36Z


  for (const heading of headings) {
+    if (heading.text.includes('Full changelog')) {
+      heading.text = heading.text.replace(' Full changelog', '')


I think that we don't need the condition above to run the line.

Indeed, updated

louismaximepiton · 2026-07-16T13:23:42Z

 }

+export function getHeadingSlug(str: string) {
+  return str.replace(/-------full-changelog---------------------/g, '')


I can't figure out why we have this specific string ?

From what I understand, rehypeHeadingIds generates slug from the content of the whole node, which includes the "full changelog" link, and generates this string.
If I don't remove it, the generated slug when clicking on anchor or TOC is #vXYZ-------full-changelog---------------------, which is not pretty in the URL.

louismaximepiton · 2026-07-16T13:49:22Z

 }
+
+// A rehype plugin to reorder header anchor link and header text
+export const rehypeHeaderLinksOrder: Plugin<[], Root> = function () {


I quite don't unserstand why we do want them in this exact order, I think title -> Full changelog -> anchor is fine no ?

If I don't reorder them, the DOM will not reflect the reading/display order, and keyboard navigation won't match what the user sees : We will see title -> anchor -> full changelog, and keyboard navigation order will be title -> full changelog -> anchor.

…ve reordering plugin

github-project-automation Bot added this to 🟣 [Orange-Boosted-Bootstrap] PRs Board Jun 12, 2026

github-project-automation Bot moved this to In Progress / Draft in 🟣 [Orange-Boosted-Bootstrap] PRs Board Jun 12, 2026

boosted-bot moved this from In Progress / Draft to Need Dev Review in 🟣 [Orange-Boosted-Bootstrap] PRs Board Jun 12, 2026

MaxLardenois requested changes Jun 15, 2026

View reviewed changes

boosted-bot moved this from Need Dev Review to Dev Review In Progress in 🟣 [Orange-Boosted-Bootstrap] PRs Board Jun 15, 2026

duvalale force-pushed the ouds/main-ad-links-to-guithub-changelog branch from 1c99711 to 0563034 Compare June 19, 2026 12:34

MaxLardenois approved these changes Jun 25, 2026

View reviewed changes

duvalale force-pushed the ouds/main-ad-links-to-guithub-changelog branch from d214b9e to 3a38f39 Compare June 25, 2026 14:48

duvalale force-pushed the ouds/main-ad-links-to-guithub-changelog branch from fcec38d to 8cd3170 Compare July 8, 2026 14:51

github-code-quality Bot found potential problems Jul 8, 2026

View reviewed changes

Comment thread site/src/libs/rehype.ts Fixed

louismaximepiton requested a review from Copilot July 9, 2026 06:06

Copilot started reviewing on behalf of louismaximepiton July 9, 2026 06:17 View session

Copilot AI reviewed Jul 9, 2026

View reviewed changes

duvalale force-pushed the ouds/main-ad-links-to-guithub-changelog branch from 82f872a to cb08b0d Compare July 9, 2026 08:08

louismaximepiton approved these changes Jul 16, 2026

View reviewed changes

boosted-bot moved this from Dev Review In Progress to Need Lead Dev Review in 🟣 [Orange-Boosted-Bootstrap] PRs Board Jul 16, 2026

duvalale added 11 commits July 16, 2026 16:26

feat: added links to github changelog to migration page headers

597e547

feat: improved version link management

42c9b11

feat: header links ordering

bb95dfd

fix: code cleaning

3f7ab74

fix: ts error on anchor class and code cleaning

c8e5fe1

feat: renamed version-link conf value and updated anchor-link to remo…

481e361

…ve reordering plugin

feat: added external link icon to version changelog link

1254a6b

feat: reordered anchor and heading and improved headings ids

db30c8a

fix: useless import

733251e

fix: changelog link icon and toc slug

4cafce8

fix: import formatting

0ee97de

duvalale added 2 commits July 16, 2026 16:26

feat: added rel attribute to changelog link

e466a11

feat: removed useless check

fea4901

duvalale force-pushed the ouds/main-ad-links-to-guithub-changelog branch from 94e305b to fea4901 Compare July 16, 2026 14:59

Uh oh!

Conversation

duvalale commented Jun 12, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Related issues

Description

Checklists

Progression (for Core Team only)

Live previews

Uh oh!

netlify Bot commented Jun 12, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Deploy Preview for boosted ready!

Uh oh!

MaxLardenois left a comment

Choose a reason for hiding this comment

Uh oh!

duvalale commented Jun 19, 2026

Uh oh!

MaxLardenois left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

MaxLardenois Jun 26, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

MaxLardenois commented Jul 9, 2026

Uh oh!

louismaximepiton left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

duvalale commented Jun 12, 2026 •

edited

Loading

netlify Bot commented Jun 12, 2026 •

edited

Loading

MaxLardenois Jun 26, 2026 •

edited

Loading