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

chore: adding autogenerated docs for noirjs #3035

Closed
wants to merge 4 commits into from

Conversation

signorecello
Copy link
Contributor

@signorecello signorecello commented Oct 8, 2023

Description

This PR works with this one on the docs repo to autogenerate documentation for the NoirJS and Barretenberg classes.

Problem*

Manually documenting the reference for NoirJS packages involves a lot of effort. Let's have machines doing it instead.

Summary

  • Added typedoc.json files
  • Made changes to tsconfig.json in the types package so it correctly resolves references
  • Ignored tsbuildinfo because it's generated by the "references" section above
  • Added some decorators

TODO

  • Finish the decoration of methods to make nice docs
  • Other visual changes

@kobyhallx kobyhallx marked this pull request as draft October 8, 2023 18:28
@kobyhallx
Copy link
Contributor

Please use draft when you do not want to merge.

@TomAFrench
Copy link
Member

TomAFrench commented Oct 8, 2023

It also adds some "quality of life" things, not related to docs so I can make them a separate PR:

Please split these out into separate PRs so they can be discussed separately. We shouldn't be making omnibus PRs as it makes it harder to review, if any of the changes are contentious then it holds up the whole lot.

@signorecello signorecello changed the title DO NOT MERGE - chore: adding autogenerated docs for noirjs chore: adding autogenerated docs for noirjs Oct 9, 2023
@signorecello signorecello force-pushed the zpedro/noirjs_autodocs branch from 7db5fa3 to c3b341e Compare October 9, 2023 14:22
@TomAFrench TomAFrench deleted the zpedro/noirjs_autodocs branch November 20, 2024 12:02
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