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

Symbols are not rendered as links in versioned API docs in v3.0.1 #110

Open
B4nan opened this issue Oct 13, 2023 · 1 comment
Open

Symbols are not rendered as links in versioned API docs in v3.0.1 #110

B4nan opened this issue Oct 13, 2023 · 1 comment

Comments

@B4nan
Copy link
Contributor

B4nan commented Oct 13, 2023

One more finding, after the upgrade, only the next version for API docs is rendering links between the symbols correctly, none of the versioned snapshots work.

I had to downgrade because of this, so here are the screenshots:

https://crawlee.dev/api/playwright-crawler/class/PlaywrightCrawler#constructor (fails)

image

https://crawlee.dev/api/next/playwright-crawler/class/PlaywrightCrawler#constructor (works)

image

FWIW I also tried to downgrade TS to 5.1 but that itself did not help, and in the end, the next version which is rendered on the fly works fine with TS 5.2.

@milesj
Copy link
Owner

milesj commented Nov 1, 2023

This just brought up a potential problem.

These old versioned datasets (api-typedoc.json) are built with an older TypeDoc version, which may have a different JSON structure. There's no guarantee that these old JSON files will be compatible continuously moving forward.

I wonder if this issue is caused by such a change.

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

No branches or pull requests

2 participants