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

CI Fixes #16

Merged
merged 4 commits into from Dec 5, 2023
Merged

CI Fixes #16

merged 4 commits into from Dec 5, 2023

Conversation

zac
Copy link
Member

@zac zac commented Nov 28, 2023

Description

  • Adds a docc to the project
  • Fixes docs build process
  • Deploys to Pages site

Copy link
Member

@weilikuo weilikuo left a comment

Choose a reason for hiding this comment

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

Really cool! The generated documentation look great 👍

While looking at the docs, I noticed that there may be some consistency issues in backtick character usage for terms like Definition. For instance, in older code, no backticks were used:

b3d4b37#diff-7994a8f69f823f327b42aff193a0a550adcbfe110b2fbd2ba2138831d4a41a26R17-R21

Compared to newer code:
b3d4b37#diff-5e3bcf573549f066c8570ebe872eb8f746c57d1974172c31e64c9a97e4a64769R13-R14

Not really noticeable but perhaps something we'd want to make consistent at some point?

@zac
Copy link
Member Author

zac commented Dec 5, 2023

@weilikuo Good point! I just pushed some changes to use the double backticks in as many places as possible. This allows for automatic linking to the types. I'm sure I missed some... and I definitely want to do a full pass on the documentation at some point soon to really tighten it up. But I think this can be a 0.2.0 for now if you agree and we can work toward that 1.0.0!

@zac zac merged commit 53512f0 into main Dec 5, 2023
1 check passed
@zac zac deleted the feature/ci-fixes branch December 5, 2023 20:37
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.

None yet

2 participants