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

docs: initial typedoc markdown #23

Merged
merged 1 commit into from
Sep 30, 2024
Merged

docs: initial typedoc markdown #23

merged 1 commit into from
Sep 30, 2024

Conversation

dohaki
Copy link
Collaborator

@dohaki dohaki commented Sep 30, 2024 •
edited
Loading

This adds some initial typedoc setup with markdown. This is not meant to be final and we need to add more typedoc annotations to the source code.

The markdown docs generation also should probably part of CI

Closes ACX-2826

@changeset-bot changeset-bot
Copy link

changeset-bot bot commented Sep 30, 2024

⚠️ No Changeset found

Latest commit: b557d07

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@vercel Vercel
Copy link

vercel bot commented Sep 30, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
toolkit-example ✅ Ready (Inspect) Visit Preview 💬 Add feedback Sep 30, 2024 11:39am

@linear Linear
Copy link

linear bot commented Sep 30, 2024

ACX-2826 Auto-generated API reference

gsteenkamp89
gsteenkamp89 approved these changes Sep 30, 2024
View reviewed changes
Copy link
Collaborator

@gsteenkamp89 gsteenkamp89 left a comment

Choose a reason for hiding this comment

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

very cool! 👏

packages/sdk/docs/functions/getDepositLogs.md

# Function: getDepositLogs()

> **getDepositLogs**(`__namedParameters`): `undefined` \| `Log`\<`bigint`, `number`, `false`, `undefined`, `true`, readonly [`object`, `object`, `object`, `object`, `object`, `object`, `object`, `object`, `object`, `object`, `object`, `object`, `object`, `object`, `object`, `object`, `object`, `object`, `object`, `object`, `object`, `object`, `object`, `object`, `object`, `object`, `object`, `object`, `object`, `object`, `object`, `object`, `object`, `object`, `object`, `object`, `object`, `object`, `object`, `object`, `object`, `object`, `object`, `object`, `object`, `object`], `"V3FundsDeposited"`\>
Copy link
Collaborator

Choose a reason for hiding this comment

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

We can probably use the generic Log type here, but if we build these docs again during CI then this will be overwritten?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Yea, we'd need to explicitly type the return type of getDepositLog via TypeScript

@dohaki dohaki merged commit fa61c35 into master Sep 30, 2024
3 checks passed
@dohaki dohaki deleted the docs-typedoc-md branch September 30, 2024 13:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@gsteenkamp89 gsteenkamp89 gsteenkamp89 approved these changes

@bmzig bmzig Awaiting requested review from bmzig

@pxrl pxrl Awaiting requested review from pxrl

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

Successfully merging this pull request may close these issues.
2 participants
@dohaki @gsteenkamp89