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

Explore and Add Feature usage examples in API Reference docs #10

Open
leordev opened this issue Nov 10, 2023 · 0 comments
Open

Explore and Add Feature usage examples in API Reference docs #10

leordev opened this issue Nov 10, 2023 · 0 comments
Labels
cicd CI/CD and Automation

Comments

@leordev
Copy link
Member

leordev commented Nov 10, 2023 •
edited
Loading

We need to explore a way to publish feature usage examples.

In kotlin we have a way to do this, example: https://tbd54566975.github.io/tbdex-kt/protocol/tbdex.sdk.protocol.serialization/-json/index.html

I suspect that we could do that in tsdocs and rust too... Just as a long comment in markdown...
@leordev leordev added the cicd CI/CD and Automation label Nov 10, 2023
@leordev leordev self-assigned this Nov 10, 2023
@leordev leordev mentioned this issue Nov 10, 2023
Closed
@leordev leordev changed the title Explore Feature usage examples in docs Explore and Add Feature usage examples in API Reference docs Nov 10, 2023
@leordev leordev transferred this issue from TBD54566975/web5-spec Nov 10, 2023
@leordev leordev removed their assignment Nov 10, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
cicd CI/CD and Automation
Projects
SDK Development
Status: Blocked
Milestone
No milestone
Development

No branches or pull requests
1 participant
@leordev