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

docs: add typedoc documentation to client-react-hooks #23

Draft
wants to merge 5 commits into
base: main
Choose a base branch
from

Conversation

cyberglot
Copy link
Collaborator

No description provided.

@cyberglot cyberglot changed the title docs: add documentation to client-react-hooks package docs: add typedoc documentation to client-react-hooks package Sep 9, 2024
@cyberglot cyberglot changed the title docs: add typedoc documentation to client-react-hooks package docs: add typedoc documentation to client-react-hooks and client-vms packages Sep 25, 2024
Copy link
Collaborator

@tim-hm tim-hm left a comment

Choose a reason for hiding this comment

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

A few points for discussuion.

  1. @oceans404 do we have a documentation style (i.e. tense, etc)?

For example:

`UseNilCompute` is a hook that allows you to execute a compute operation on Nillion.

or

The `UseNilCompute` hook executes a compute operation on Nillion.

or

something else entirely?

  1. I've started a thread in the toolchain team channel to discuss if we should keep the generated html pages.

package.json Outdated Show resolved Hide resolved
packages/client-react-hooks/src/use-nil-compute.ts Outdated Show resolved Hide resolved
typedoc.json Outdated Show resolved Hide resolved
@cyberglot cyberglot force-pushed the origin/docs/typedoc-react-hooks branch from 5e742ee to 14591a2 Compare October 9, 2024 11:31
@cyberglot cyberglot force-pushed the origin/docs/typedoc-react-hooks branch 5 times, most recently from 9079117 to f1d0672 Compare October 10, 2024 22:36
@cyberglot cyberglot force-pushed the origin/docs/typedoc-react-hooks branch from f1d0672 to cd5ebd1 Compare October 10, 2024 22:44
@cyberglot cyberglot requested a review from tim-hm October 10, 2024 22:45
Copy link

github-actions bot commented Nov 5, 2024

Coverage Report for ./client-vms

Status Category Percentage Covered / Total
🔵 Lines 88.36% 1572 / 1779
🔵 Statements 88.36% 1572 / 1779
🔵 Functions 84.87% 174 / 205
🔵 Branches 90.19% 230 / 255
File CoverageNo changed files found.
Generated in workflow #30 for commit b1a5d61 by the Vitest Coverage Report Action

@cyberglot cyberglot changed the title docs: add typedoc documentation to client-react-hooks and client-vms packages docs: add typedoc documentation to client-react-hooks Nov 5, 2024
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.

2 participants