excaliburjs / Excalibur

🎮 Your friendly TypeScript 2D game engine for the web 🗡️
https://excaliburjs.com
BSD 2-Clause "Simplified" License
1.82k stars 189 forks source link

docs: Update all engine source code Markdown comment symbol links to `{@apilink}` #3132

Closed kamranayub closed 3 months ago

kamranayub commented 3 months ago

We need to go around and fix up all the Markdown symbol links in the engine source code so they get rendered properly in the docs API site.

Steps to Reproduce

On API pages, links between API symbols used to be done using the legacy symbol markup:

This is a link to the [[Actor]] class.

This is a link to the [[Actor|actor]] class with custom display text.

These should all be switched to {@apilink symbol | text} links (docs).

You can refer to src\engine\Actions\ActionContext.ts for an example that works.

NOTE: Using the official {@link} tag doesn't quite work as expected all the time, so for consistency I recommend @apilink.

Expected Result

The links should work.

Example:

image

Actual Result

The links are rendered in plaintext.

Example:

image

kamranayub commented 3 months ago

If someone can get GitHub Copilot to do this, you'd be a hero 🤖

Autsider666 commented 3 months ago

I've some free time today, so let me see if I can do this using search/replace combined with regex