Clicking on anchors adds backslashes before periods

[glasser]

• Go to https://www.apollographql.com/docs/engine/proxy-release-notes.html
• Click on the link icon to the left of the v1.0.4 header
• It properly smooth scrolls to the top
• Look at the URL bar
• See https://www.apollographql.com/docs/engine/proxy-release-notes.html#v1\.0\.4

Where did the backslashes come from? They break links. Note that "copy link address" on the link gets the right error without backslash.

@abernix this might be up your alley?

[abernix]

Yes, I've seen this and I presume it's something in our scripts doing it (probably the thing that highlights the sidebar or auto-expands the sub-headings when you're within that section?) but haven't looked into what it is yet.

[abernix]

This hadn't been a more prominent problem until proxy-release-notes.md since markdown header-syntax (e.g. #, ##, ###) normally replaces symbols (something along the lines of [\W], I believe) with hyphens (-) when it generates the ids for the resulting <h#> tags.

In the case of proxy-release-notes.md (and other newer docs markdown), we manually generate the anchor to prevent it from breaking permalinks if we change the header itself, and the proxy versions are some of the only headers which utilize periods (à la, 1.0.4) causing this smooth-scroll bug to rear its head.

Anyhow, fixed with an upgrade of smooth-scroll (which is now served via CDN too). 248d0ba.

Thanks for reporting this!

[glasser]

Yeah, I didn't think it was helpful to include dates in the anchors along with the version number. Thanks!

[abernix]

What you did absolutely makes sense, just verbalizing the reason why this is cropping up now. I'll deploy this next week after I've bunched some more features to reduce PR/update noise.

[abernix]

@glasser This is deployed now to the Engine docs! (i.e. fixed).

[glasser]

Thanks!