Skip to content

Fix Table of Content links#415

Open
cjrobbertse-ob wants to merge 14 commits intov4.0.1from
fix/fix-toc-links
Open

Fix Table of Content links#415
cjrobbertse-ob wants to merge 14 commits intov4.0.1from
fix/fix-toc-links

Conversation

@cjrobbertse-ob
Copy link

@cjrobbertse-ob cjrobbertse-ob commented Mar 2, 2026

@cjrobbertse-ob cjrobbertse-ob marked this pull request as ready for review March 2, 2026 14:45
MikeBanyard1
MikeBanyard1 previously approved these changes Mar 2, 2026
Copy link

@MikeBanyard1 MikeBanyard1 left a comment

Choose a reason for hiding this comment

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

lgtm

Copy link
Contributor

@OBPeteS OBPeteS left a comment

Choose a reason for hiding this comment

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

1 change requested and a couple of comments asking for further details on changes


module.exports = {
base: '/read-write-api-site3/',
base: '/test-toc-links/',
Copy link
Contributor

Choose a reason for hiding this comment

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

This needs changing back to the prod url

lineNumbers: false,
// options for markdown-it-anchor
anchor: {
permalinkBefore: true,
Copy link
Contributor

Choose a reason for hiding this comment

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

What's the impact (if any of this being removed?)

Copy link
Author

Choose a reason for hiding this comment

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

The docs said they apply by default, so there should be no change. But I can change them back for consistency?

.badge
vertical-align middle

.table-of-contents > ul > li > a
Copy link
Contributor

Choose a reason for hiding this comment

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

Can you cover off this addition please so we have a record of why it was added on the PR

Copy link
Author

Choose a reason for hiding this comment

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

I've added some comments. let me know if that suffices?

smoothScroll: true,
lastUpdated: false,
},
markdown: markdownConfig,
Copy link
Contributor

Choose a reason for hiding this comment

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

Can you cover this addition please

Copy link
Author

Choose a reason for hiding this comment

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

I have added some comments addressing this addition. However, for context, the markdown config file already existed, but was never imported directly into the VuePress config - now it is :)

@cjrobbertse-ob cjrobbertse-ob changed the title Fix/fix toc links Fix Table of Content links Mar 2, 2026
@cjrobbertse-ob cjrobbertse-ob requested a review from OBPeteS March 2, 2026 17:34
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