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

Autogenerate documentation #41

Closed
wants to merge 15 commits into from
Closed

Autogenerate documentation #41

wants to merge 15 commits into from

Conversation

kai-gitt
Copy link
Member

@kai-gitt kai-gitt commented Aug 13, 2023

This commit adds typedoc documentation generation that also automatically on push to main, updates the github wiki with fresh markdown.

pros:
we do not need to documentation ourselves

cons:
it overwrites the entire wiki, meaning that it's basically read-only
does not anymore, it just updates all other files

@kai-gitt kai-gitt added the enhancement New feature or request label Aug 13, 2023
@kai-gitt kai-gitt requested a review from zefir-git August 13, 2023 02:10
@kai-gitt kai-gitt linked an issue Aug 13, 2023 that may be closed by this pull request
@kai-gitt kai-gitt self-assigned this Aug 13, 2023
@zefir-git
Copy link
Member

zefir-git commented Aug 13, 2023

These docs don't really make sense to me
image
image

I wanted to have some web docs like javadoc where it directly shows you the classes & interfaces, including what extends what, what it inherits, etc. Because of export default this thinks all of our classes are named default which is really weird. We could host web docs on GH pages

@zefir-git
Copy link
Member

We have taken another approach to documentation generation.

@zefir-git zefir-git closed this Aug 19, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

[Feature]: generate docs
2 participants