Skip to content

Polish and deploy API documentation #76

@web-padawan

Description

@web-padawan

We should publish API docs for web components released from the monorepo.

I would suggest to use them all in a single URL (not in separate builds as we had before), e.g. like this:

https://cdn.vaadin.com/vaadin-web-components/%version%

This way we can have simple structure, and make cross references between components work.

One problem is what to do with internal components. Possible solution is to tweak analysis.json to filter out those components that have @privateJSDoc annotation (because polymer-analyzer does not do it automatically).

If we exclude components like <vaadin-select-overlay> from docs, we should update Styling sections for the main components so that they refer to the stylable shadow parts for each of those internal components.

Metadata

Metadata

Assignees

Labels

documentationImprovements or additions to documentation

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions