API Docs Standardisation

[sustained]

trafficstars

Rendered

This RFC relates to the inconsistencies/lack of cohesion between the different VuePress-based API docs for Vue, Vuex, Vue Router, Vue CLI etc.

[yyx990803]

This is definitely a good area for improvement (especially as we are reworking the core docs for v3).

We will most likely explore generating API references automatically from TS typings (we can already generate api.json files using api-extractor for vue-next). Once we find that working well we can apply that workflow to sub projects as well.

[sustained]

Thanks for the response.

That sounds promising, I will definitely have to take a closer look at this "api-extractor" and the JSON it generates for vue-next. Just to clarify, you are referring to this Microsoft tool, yes?

[yyx990803]

@sustained yes, vue-next uses it to rollup types and extract API metadata.

[CyberAP]

@yyx990803 I think people would also appreciate if Vue 3 docs had examples written both in JS and TS, where you could toggle between those two.

[yyx990803]

@CyberAP TS code and JS code will look almost the same as most of the APIs provide decent inference.