Skip to content

chore: replace Polymer based API docs with the new website #9975

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
Aug 12, 2025
Merged

chore: replace Polymer based API docs with the new website #9975

merged 3 commits into from
Aug 12, 2025

Conversation

web-padawan
Copy link
Member

@web-padawan web-padawan commented Aug 12, 2025 •
edited
Loading

Description

Follow-up to #9803

  • Replaced old API docs with the new website
  • Removed no longer used docs and dist scripts
  • Added 11ty plugin to specify path prefix

The API docs build will need to be adjusted e.g. like this:

if [ -d "api-docs" ]; then 
  yarn api-docs:build --pathprefix=/vaadin-web-components/%version%/
  cp -r api-docs/dist dist
else
  yarn dist
fi

Type of change

  • Internal change

@sonarqubecloud SonarQubeCloud
Copy link

Quality Gate Passed Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

@web-padawan web-padawan merged commit 14007be into main Aug 12, 2025
9 checks passed
@web-padawan web-padawan deleted the chore/replace-api-docs branch August 12, 2025 13:49
@web-padawan web-padawan mentioned this pull request Aug 14, 2025
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@sissbruecker sissbruecker sissbruecker approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@web-padawan @sissbruecker