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

Add a PR template and typedoc site generation #83

Merged
merged 2 commits into from
Oct 5, 2021
Merged

Add a PR template and typedoc site generation #83

merged 2 commits into from
Oct 5, 2021

Conversation

katspaugh
Copy link
Member

This PR adds a PR template to make linking PRs to issues easier.

It also introduces a github action that generates HTML docs based on types and deploys them to GitHub Pages.
Once this is merged, GitHub Pages need to be enabled.

Docs screenshot

Screenshot 2021-10-05 at 13 07 19

How to enable GitHub pages

Screenshot 2021-10-05 at 13 09 15

@katspaugh katspaugh requested a review from germartinez October 5, 2021 11:09
@katspaugh katspaugh added the documentation Improvements or additions to documentation label Oct 5, 2021
@github-actions
Copy link

github-actions bot commented Oct 5, 2021

CLA Assistant Lite All Contributors have signed the CLA.

@katspaugh
Copy link
Member Author

I have read the CLA Document and I hereby sign the CLA

@katspaugh katspaugh merged commit d5a6e5f into main Oct 5, 2021
@katspaugh katspaugh deleted the github branch October 5, 2021 11:46
@github-actions github-actions bot locked and limited conversation to collaborators Oct 5, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants