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

SDK Documentation #2523

Open
meaghanfitzgerald opened this issue Jan 6, 2025 · 0 comments
Open

SDK Documentation #2523

meaghanfitzgerald opened this issue Jan 6, 2025 · 0 comments
Assignees
Milestone

Comments

@meaghanfitzgerald
Copy link
Collaborator

Goal

The Tooling SDK currently implemented in the CLI flows has a plethora of use functions. Without looking at the CLI's codebase however, an open source developer would not know the SDK exists nor how to use it.

Assumptions and Scope

Create local .md documentation in the CLI repo that can be remotely referenced and imported into the github.com/ava-labs/avalanche-docs repo and website.

Extensively document functions with example usage, and organize function by package name.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Backlog 🗄️
Development

No branches or pull requests

2 participants