Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Closed
kamranayub opened this issue Jul 19, 2024 · 2 comments · Fixed by #3137
Closed

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

kamranayub opened this issue Jul 19, 2024 · 2 comments · Fixed by #3137
Labels
chore Maintenance tasks, like upgrading libraries or release tasks docs Relating to documentation in any way good first issue good for people new to open source and Excalibur help wanted asking for help from the community, may require a certain platform or skill set to implement

Comments

@kamranayub
Copy link
Member

kamranayub commented Jul 19, 2024

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 kamranayub added docs Relating to documentation in any way help wanted asking for help from the community, may require a certain platform or skill set to implement good first issue good for people new to open source and Excalibur chore Maintenance tasks, like upgrading libraries or release tasks labels Jul 19, 2024
@kamranayub kamranayub changed the title docs: Update all Markdown comment symbol links to {@apilink} docs: Update all engine source code Markdown comment symbol links to {@apilink} Jul 19, 2024
@kamranayub
Copy link
Member Author

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

@Autsider666
Copy link
Contributor

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
chore Maintenance tasks, like upgrading libraries or release tasks docs Relating to documentation in any way good first issue good for people new to open source and Excalibur help wanted asking for help from the community, may require a certain platform or skill set to implement
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants