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

Remove hack to get relative markdown links in JSDocs to work with typedoc #1243

Closed
1 task
pokey opened this issue Feb 1, 2023 · 1 comment
Closed
1 task
Labels
code quality Improvements to code quality

Comments

@pokey
Copy link
Member

pokey commented Feb 1, 2023

In #1225, we introduced a hack to rewrite markdown links that appear in JSDocs to work around typedoc2md/typedoc-plugin-markdown#394, which was the cause of CI failures such as https://github.com/cursorless-dev/cursorless/actions/runs/4022134484/jobs/6911611154. We'd like to remove this hack once that issue is resolved

@pokey pokey added the code quality Improvements to code quality label Feb 1, 2023
@pokey
Copy link
Member Author

pokey commented Feb 6, 2023

Realised VSCode hover wasn't actually working. Without that constraint, it's not hard to get these links to work, as we don't need to do any re-writing; we just have them be what docusaurus wants in the first place.

See typedoc2md/typedoc-plugin-markdown#394 (comment)

@pokey pokey closed this as not planned Won't fix, can't repro, duplicate, stale Feb 6, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
code quality Improvements to code quality
Projects
None yet
Development

No branches or pull requests

1 participant