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: #3132 Update all Markdown comment symbol links to {@apilink} #3137

Conversation

Autsider666
Copy link
Contributor

@Autsider666 Autsider666 commented Jul 23, 2024

Used the following setup to search for and replace the Markdown comments:
Search: \[\[([a-zA-Z 0-9._]*)\|([a-zA-Z 0-9._]*)\]\] and \[\[([a-zA-Z 0-9._]*)\]\]
Replace: {@apilink $1 | $2} and {@apilink $1}

I wasn't sure if all the "normal" comments had to be replaced as wel, because src/engine/Actions/ActionContext.ts contains both {@apilink Action} and [[EasingFunctions]]. It's easy to do with a small modification, so give me a shout if that's preferred.

Closes #3132

@kamranayub
Copy link
Member

Yes all the [[link]] variations need to be replaced as well!

The only thing we will need to do is spot check all the references to make sure they are resolved as well. By default the build will not fail if the resolution is missing and it'll output plain text.

@kamranayub
Copy link
Member

@eonarheim we may need to add a preview env for this PR to check the built site

@eonarheim
Copy link
Member

@kamranayub Yah, I think I'll pull it locally. Currently the automation isn't running on forks

@kamranayub
Copy link
Member

@Autsider666 Oops, the changes should only be done in src/engine folder. site docs doesn't have this problem. 👍

@Autsider666
Copy link
Contributor Author

Autsider666 commented Jul 24, 2024

I reverted the changes in site, also replaced the [[link]] variants and scoured the code for weird edgecases (like [[CoordPlane|coordinate plane|]] in TransformComponent). Took the liberty to remove the last ex. used in these links as well.

Now I just have 1 question left: What about this example in CONTRIBUTING.md?

/** @deprecated use [[SomeClass]].someNewFunction instead **/
@obsolete({message: 'ex.SomeClass.someFunction is deprecated, and will be removed in 0.2.0',
	alternateMethod: 'SomeClass.someNewFunction'})
public someFunction() {...}

Edit: Isn't it supposed to be [[SomeClass.someNewFunction]] by the way?

@eonarheim
Copy link
Member

I reverted the changes in site, also replaced the [[link]] variants and scoured the code for weird edgecases (like [[CoordPlane|coordinate plane|]] in TransformComponent). Took the liberty to remove the last ex. used in these links as well.

Now I just have 1 question left: What about this example in CONTRIBUTING.md?

/** @deprecated use [[SomeClass]].someNewFunction instead **/
@obsolete({message: 'ex.SomeClass.someFunction is deprecated, and will be removed in 0.2.0',
	alternateMethod: 'SomeClass.someNewFunction'})
public someFunction() {...}

Edit: Isn't it supposed to be [[SomeClass.someNewFunction]] by the way?

Awesome, yes I think you're right.

I'll run this locally quick to double check everything looks good before merge

Copy link
Member

@eonarheim eonarheim left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@Autsider666 bravo! Everything looks fantastic this will greatly improve the usability of the docs

@eonarheim eonarheim merged commit 2f4360d into excaliburjs:main Jul 24, 2024
4 checks passed
@kamranayub
Copy link
Member

HERO AMONG HEROES

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

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