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.

Sign up for GitHub

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

Jump to bottom

fix(docs): clean up types and create API documentation website #27

Merged
merged 1 commit into from
Jun 28, 2024
Merged

fix(docs): clean up types and create API documentation website #27

merged 1 commit into from
Jun 28, 2024

Conversation

erickzhao
Copy link
Member

  • Converts type and interface comments to use multiline comments so they can be picked up by Intellisense.
  • Link between types and to external documentation whenever possible.
  • Exports a few extra types that are referenced within things that are already exported.
  • Adds a TypeDoc API documentation website.

Website preview: https://erickzhao.github.io/windows-sign/

@erickzhao erickzhao requested a review from a team as a code owner June 20, 2024 22:47
@erickzhao erickzhao requested a review from felixrieseberg June 20, 2024 22:47
felixrieseberg
felixrieseberg approved these changes Jun 20, 2024
View reviewed changes
Copy link
Member

@felixrieseberg felixrieseberg left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great, thank you!

@erickzhao erickzhao changed the title docs: clean up types and create API documentation website fix(docs): clean up types and create API documentation website Jun 20, 2024
@erickzhao erickzhao merged commit 812e781 into main Jun 28, 2024
5 checks passed
@erickzhao erickzhao deleted the api-docs branch June 28, 2024 16:02
@continuous-auth Continuous Auth
Copy link

🎉 This PR is included in version 1.1.3 🎉

The release is available on:

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@felixrieseberg felixrieseberg felixrieseberg approved these changes

Assignees
No one assigned
Labels
released
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@erickzhao @felixrieseberg