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

feat(docs): Include aztec rpc interface typedoc output in docs #2255

Merged
merged 11 commits into from
Sep 19, 2023
Merged

feat(docs): Include aztec rpc interface typedoc output in docs #2255

merged 11 commits into from
Sep 19, 2023

Conversation

spalladino
Copy link
Collaborator

Includes the output of running typedoc on the AztecRPC interface into a new "API Reference" section on the docsite.

image

@socket-security
Copy link

socket-security bot commented Sep 12, 2023 •
edited
Loading

New dependencies detected. Learn more about Socket for GitHub ↗︎

Packages Version New capabilities Transitives Size Publisher
typedoc-plugin-markdown 3.16.0 eval, filesystem +3 4.22 MB tgreyuk

@iAmMichaelConnor
Copy link
Contributor

Based on the screenshot, and looking at the code changes, this seems lovely!
I haven't tried to build and browse these docs myself, because I can see CI failed to build them. Happy to approve this change based on what I've seen though, once it builds successfully :)

@spalladino
Copy link
Collaborator Author

Well, it's gonna take some time to get the CI to like this, since now docs has a dependency on the yarn-project. I'll freeze this for a bit while I work on the AuthWit wallet changes.

@spalladino spalladino force-pushed the palla/typedoc-in-docs branch from 62590b2 to 392d97b Compare September 18, 2023 18:53
@spalladino spalladino merged commit 62c9e9b into master Sep 19, 2023
2 checks passed
@spalladino spalladino deleted the palla/typedoc-in-docs branch September 19, 2023 16:19
@AztecBot AztecBot mentioned this pull request Sep 19, 2023
Merged
spalladino added a commit that referenced this pull request Sep 19, 2023
@spalladino
fix(docs): Revert include aztec rpc interface typedoc output in docs (#…
f852432 
…2255)

This reverts commit 62c9e9b.
@spalladino spalladino mentioned this pull request Sep 19, 2023
Closed
PhilWindle pushed a commit that referenced this pull request Sep 20, 2023
@AztecBot
chore(master): Release 0.7.10 (#2401)
e4b559e 
🤖 I have created a release *beep* *boop*
---


<details><summary>aztec-packages: 0.7.10</summary>

##
[0.7.10](aztec-packages-v0.7.9...aztec-packages-v0.7.10)
(2023-09-20)


### Features

* Aztec-cli unbox "really empty box"
([#2388](#2388))
([b57182d](b57182d))
* **docs:** Document noir macros
([#2016](#2016))
([1f1a17f](1f1a17f))
* **docs:** Include aztec rpc interface typedoc output in docs
([#2255](#2255))
([62c9e9b](62c9e9b))
* **token portal standard:** Create a token portal standard
([#2351](#2351))
([426a3ea](426a3ea))


### Bug Fixes

* **build:** Fix build system post deployment tests
([#2420](#2420))
([d509dc3](d509dc3))
* CLI encoding for arrays and structs
([#2407](#2407))
([85283bd](85283bd))
* Correct sandbox addresses in up-quick-start test
([#2412](#2412))
([974d859](974d859))
* **docs:** Revert include aztec rpc interface typedoc output in docs
([#2255](#2255))
([f852432](f852432))
* Handle falsy bigints in json-rpc
([#2403](#2403))
([d100650](d100650)),
closes
[#2402](#2402)
* **nargo_check.sh:** UNIX standard grep
([#2396](#2396))
([02e788a](02e788a))


### Miscellaneous

* **docs:** Note getter options
([#2411](#2411))
([8a95d8c](8a95d8c))
* Update docs url in config
([#2386](#2386))
([e44066d](e44066d))
</details>

<details><summary>barretenberg.js: 0.7.10</summary>

##
[0.7.10](barretenberg.js-v0.7.9...barretenberg.js-v0.7.10)
(2023-09-20)


### Miscellaneous

* **barretenberg.js:** Synchronize aztec-packages versions
</details>

<details><summary>barretenberg: 0.7.10</summary>

##
[0.7.10](barretenberg-v0.7.9...barretenberg-v0.7.10)
(2023-09-20)


### Miscellaneous

* **barretenberg:** Synchronize aztec-packages versions
</details>

---
This PR was generated with [Release
Please](https://github.com/googleapis/release-please). See
[documentation](https://github.com/googleapis/release-please#release-please).
spalladino added a commit that referenced this pull request Sep 21, 2023
@spalladino
Revert "fix(docs): Revert include aztec rpc interface typedoc output …
e2ab332 
…in docs (#2255)"

This reverts commit f852432.
@spalladino spalladino mentioned this pull request Sep 21, 2023
Merged
spalladino added a commit that referenced this pull request Sep 22, 2023
@spalladino
feat(docs): Reenable typedoc for aztec-rpc and aztec.js (#2452)
85e504c 
Attempts another shot at
#2255, but this time
including a build script specific to Netlify. Includes aztec.js contract
and account modules, and expands some inline docs.


![image](https://github.com/AztecProtocol/aztec-packages/assets/429604/9bc9af0b-9d4c-44e3-ab9f-69b491a687c8)

Fixes #2044 
Fixes #2045
Fixes #2046 
Fixes #2415
ludamad pushed a commit to AztecProtocol/docs that referenced this pull request Sep 26, 2023
@spalladino @ludamad
feat(docs): Reenable typedoc for aztec-rpc and aztec.js (#2452)
cce49ce 
Attempts another shot at
AztecProtocol/aztec-packages#2255, but this time
including a build script specific to Netlify. Includes aztec.js contract
and account modules, and expands some inline docs.


![image](https://github.com/AztecProtocol/aztec-packages/assets/429604/9bc9af0b-9d4c-44e3-ab9f-69b491a687c8)

Fixes #2044 
Fixes #2045
Fixes #2046 
Fixes #2415
@rahul-kothari
Copy link
Contributor

Hmm looking at master rn, something seems off
docs/apis folder is in gitignore. And there is no API reference to aztec.js which causes my sidebars.js to fail?

@spalladino
Copy link
Collaborator Author

@rahul-kothari have you run yarn preprocess && yarn typedoc before docusaurus start?

@rahul-kothari
Copy link
Contributor

Yup. yarn start;dev:local gives an error locally. But not on the CI
image

😢

@spalladino
Copy link
Collaborator Author

Can you run a yarn build at the root of yarn-project?

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

@benesjan benesjan benesjan approved these changes

@iAmMichaelConnor iAmMichaelConnor Awaiting requested review from iAmMichaelConnor

@critesjosh critesjosh Awaiting requested review from critesjosh

Assignees
No one assigned
Labels
None yet
Projects
A3
Archived in project
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@spalladino @iAmMichaelConnor @rahul-kothari @benesjan