Skip to content

docs: prepare API docs for publishing #77

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 3 commits into from
Mar 22, 2021
Merged

docs: prepare API docs for publishing #77

merged 3 commits into from
Mar 22, 2021

Conversation

@web-padawan
Copy link
Member

@web-padawan web-padawan commented Mar 15, 2021 •
edited
Loading

Fixes #76

  1. Updated API docs to not list internal elements. Instead, the corresponding public elements list their stylable parts
  2. Removed individual API docs pages from packages, and adde the single top-level API docs build.

To test the PR locally:

yarn dist
yarn serve:dist

@web-padawan web-padawan merged commit e5c6645 into master Mar 22, 2021
@web-padawan web-padawan deleted the api-docs branch March 22, 2021 14:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

1 more reviewer

@sosa-vaadin sosa-vaadin sosa-vaadin approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Polish and deploy API documentation

3 participants

@web-padawan @sosa-vaadin