igniteui-webcomponents icon indicating copy to clipboard operation
igniteui-webcomponents copied to clipboard

Versioning dropdown for WC API docs

Open dkamburov opened this issue 2 years ago • 3 comments

dkamburov avatar Nov 27 '23 08:11 dkamburov

@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 avatar Nov 29 '23 11:11 MayaKirova

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

MayaKirova avatar Nov 29 '23 13:11 MayaKirova

I've logged the issues for the related repos:

  • https://infragistics.visualstudio.com/NetAdvantage/_workitems/edit/28200
  • https://github.com/IgniteUI/igniteui-dockmanager/issues/92

dkamburov avatar Nov 29 '23 14:11 dkamburov