QwikDev / qwik

Instant-loading web apps, without effort
https://qwik.dev
MIT License
20.6k stars 1.28k forks source link

[📖] Conflicting links and entries in API reference page #5811

Open EatChangmyeong opened 6 months ago

EatChangmyeong commented 6 months ago

Suggestion

A number of API reference links and entries with same or similar name, or names with special characters, are broken.

Affected entries in qwik are:

I didn't check other modules, but I strongly believe that they are also affected.

wmertens commented 6 months ago

these are automatically generated by https://api-extractor.com/ so that's either a bug for them or a setting we need to change? The generation happens in https://github.com/BuilderIO/qwik/blob/main/scripts/api.ts

JerryWu1234 commented 6 months ago

these are automatically generated by https://api-extractor.com/ so that's either a bug for them or a setting we need to change? The generation happens in https://github.com/BuilderIO/qwik/blob/main/scripts/api.ts

I saw that the APi was directly generated by https://api-extractor.com/, what can we do here ?

wmertens commented 6 months ago

@JerryWu1234 you can help by figuring out if this is a bug in api-extractor, or a missing setting. PRs always very welcome!