IgniteUI / igniteui-webcomponents

Ignite UI for Web Components is a complete library of UI components, giving you the ability to build modern web applications using encapsulation and the concept of reusable components in a dependency-free approach.
https://www.infragistics.com/products/ignite-ui-web-components
Other
114 stars 2 forks source link

Versioning dropdown for WC API docs #991

Open dkamburov opened 7 months ago

MayaKirova commented 7 months ago

@dkamburov Note that there are 3 different web components api docs right now: 1) For the xplat components (chart, input, grid etc,) at: https://www.infragistics.com/products/ignite-ui-web-components/api/docs/typescript/latest/ 2) For the native wc components (button, icon, badge etc.) at: https://www.infragistics.com/products/ignite-ui-web-components/docs/typescript/latest/ 3) For the doc manager: https://www.infragistics.com/products/ignite-ui/dock-manager/docs/typescript/latest/

Each one gets generated from a different source and each has different version (version numbers are completely different). So each one will require it's own independent release process for managing its api docs versions. We could split this task in 3 task for each one.

MayaKirova commented 7 months ago

As each of these will need specific urls, they need unique config file at: https://github.com/IgniteUI/ig-typedoc-theme/tree/master Similar to the ones for angular(config.json) and react(react.config.json).

So proposition is to first add new config options, similar to the existing product in the localization plugin. So that each can target their own config file, for example:

Xplat components - webcomponents.licensed.config.json Native wc components - webcomponents.oss.config.json DockManager - webcomponents.dockmanager.config.json

dkamburov commented 7 months ago

I've logged the issues for the related repos: