Skip to content

feat(other): typedoc#89

Merged
ulfgebhardt merged 12 commits into
mainfrom
typedoc
Feb 4, 2025
Merged

feat(other): typedoc#89
ulfgebhardt merged 12 commits into
mainfrom
typedoc

Conversation

@ulfgebhardt

@ulfgebhardt ulfgebhardt commented Jan 31, 2025

Copy link
Copy Markdown
Member

🍰 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

antontranelis commented Feb 3, 2025

Copy link
Copy Markdown
Member

grafik

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

@Mogge

Mogge commented Feb 4, 2025

Copy link
Copy Markdown
Contributor

Follow issue would be type documentation
image

@ulfgebhardt
ulfgebhardt merged commit c71b4f5 into main Feb 4, 2025
@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