search

milesj / docusaurus-plugin-typedoc-api

Docusaurus plugin that provides source code API documentation powered by TypeDoc.
69 stars 25 forks source link

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

Open B4nan opened 11 months ago

B4nan commented 11 months ago

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 commented 10 months ago

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.