Closed kamranayub closed 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.
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).
{@apilink symbol | text}
You can refer to src\engine\Actions\ActionContext.ts for an example that works.
src\engine\Actions\ActionContext.ts
NOTE: Using the official {@link} tag doesn't quite work as expected all the time, so for consistency I recommend @apilink.
{@link}
@apilink
The links should work.
Example:
The links are rendered in plaintext.
If someone can get GitHub Copilot to do this, you'd be a hero 🤖
I've some free time today, so let me see if I can do this using search/replace combined with regex
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:
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.Expected Result
The links should work.
Example:
Actual Result
The links are rendered in plaintext.
Example: