Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Versioning dropdown for WC API docs #991

Open
dkamburov opened this issue Nov 27, 2023 · 3 comments
Open

Versioning dropdown for WC API docs #991

dkamburov opened this issue Nov 27, 2023 · 3 comments

Comments

@dkamburov
Copy link
Contributor

No description provided.

@MayaKirova
Copy link
Contributor

@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
Copy link
Contributor

MayaKirova commented Nov 29, 2023

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
Copy link
Contributor Author

I've logged the issues for the related repos:

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants