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

feat(other): typedoc #89

Merged
merged 12 commits into from
Feb 4, 2025
Merged

feat(other): typedoc #89

merged 12 commits into from
Feb 4, 2025

Conversation

ulfgebhardt
Copy link
Member

@ulfgebhardt ulfgebhardt commented Jan 31, 2025

🍰 Pullrequest

typedoc

Introduces documentation Generation to document the API

provides new command npm run docs:generate

image
image

The thing is published on github pages: https://utopia-os.org/utopia-ui/

Issues

Todo

  • Check if docs build as workflow
  • Publish docs as github page
  • Remove typedoc branch from github pages protection rules
  • Publish only on push to main

@ulfgebhardt ulfgebhardt self-assigned this Jan 31, 2025
@ulfgebhardt ulfgebhardt changed the title feat(other): typedoc [WIP] feat(other): typedoc Jan 31, 2025
@ulfgebhardt ulfgebhardt changed the title [WIP] feat(other): typedoc feat(other): typedoc Feb 3, 2025
@antontranelis
Copy link
Contributor

antontranelis commented Feb 3, 2025

grafik

this happens when I try to generate the docs on my machine (node v18.19.1)

@Mogge
Copy link
Contributor

Mogge commented Feb 4, 2025

Follow issue would be type documentation
image

@ulfgebhardt ulfgebhardt merged commit c71b4f5 into main Feb 4, 2025
13 checks passed
@ulfgebhardt ulfgebhardt deleted the typedoc branch February 19, 2025 13:31
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

Successfully merging this pull request may close these issues.

3 participants