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

Use Typedoc for Wasm API docs #1399

Merged
merged 26 commits into from
Sep 10, 2024
Merged

Use Typedoc for Wasm API docs #1399

merged 26 commits into from
Sep 10, 2024

Conversation

eike-hass
Copy link
Collaborator

@eike-hass eike-hass commented Aug 27, 2024

Description of change

Migrate Wasm documentation tooling to Typedoc to align with IF-wide tooling and simplify adding new versions to the Wiki.

Type of change

Add an x to the boxes that are relevant to your changes.

  • Bug fix (a non-breaking change which fixes an issue)
  • Enhancement (a non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Documentation Fix

How the change has been tested

Ran CI action with retargeted workflow sources.

Change checklist

Add an x to the boxes that are relevant to your changes.

  • I have followed the contribution guidelines for this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes

@eike-hass eike-hass added the No changelog Excludes PR from becoming part of any changelog label Aug 28, 2024
@eike-hass eike-hass marked this pull request as ready for review August 28, 2024 08:45
@eike-hass eike-hass requested a review from a team as a code owner August 28, 2024 08:45
.github/workflows/shared-build-wasm.yml Show resolved Hide resolved
.github/workflows/upload-docs.yml Outdated Show resolved Hide resolved
bindings/wasm/typedoc.json Outdated Show resolved Hide resolved
bindings/wasm/package.json Show resolved Hide resolved
.github/workflows/upload-docs.yml Outdated Show resolved Hide resolved
@eike-hass eike-hass changed the title Typedoc Use Typedoc for Wasm API docs Sep 10, 2024
@eike-hass eike-hass merged commit a0c7b06 into main Sep 10, 2024
12 of 15 checks passed
@eike-hass eike-hass deleted the typedoc branch September 10, 2024 10:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
No changelog Excludes PR from becoming part of any changelog
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants