Type links broken in documentation

[mapsam]

It appears all of our type links (i.e. ([LngLatBoundsLike])) are broken in our documentation. For example types that are pointing to the #Map class currently point to

https://www.mapbox.com/mapbox-gl-js/api/#map

when they should be pointing to the uppercase version

https://www.mapbox.com/mapbox-gl-js/api/#Map

Since these are id strings, the capitals matter, so the fragments aren't working as expected. This may be related to an upstream documentation.js issue. I will do some digging.

cc @lucaswoj @lyzidiamond @tmcw

[mapsam]

Looks like this is a known issue: documentationjs/documentation#525

@tmcw has started some work on a fix here: documentationjs/documentation#537

[jfirebaugh]

#3445 is a special case of this.

[tmcw]

Yep, if you can test out that branch, go for it... I'd like to finish out that work - it requires a solid chunk of time to think of All The Cases of All The Things That Might Happen.

[andrewharvey]

It looks like this is fixed now!

[lucaswoj]

Unfortunately this is not fixed in all cases :-(

[lucaswoj]

Fixed by #4460 😄

[andrewharvey]

Unfortunately I don't think this is completely fixed. In the code some places use {@link foo} while others use [Foo](Foo), the latter remains unfixed.

For example at https://www.mapbox.com/mapbox-gl-js/api/#map#fitbounds under options.easing the AnimationOptions link is broken.

I think we can simply migrate occurrences of [Foo](Foo) to {@link foo} to fix this, the inconsistency in style here is confusing as they appear to do the same thing.

I don't think documentation.js supports all the link formatting options from JSDoc. This is an issue as some of the current markdown style links are monospaced and some aren't.

If we want to retain that monospaced formatting then I'm not sure if we can move to {@link foo}.

Related to but not the same issue as #4568

[kronick]

This seems like a tough one to squash! I'm seeing it broken still on https://www.mapbox.com/mapbox-gl-js/api/#LngLatLike . Anybody familiar with the innards of how we generate docs able to pick this one up?

[mollymerp]

fixed this in #4668 – still need to figure out #4568