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

Tell users how to get started with the SDK. #289

Open
2 tasks done
johnnymatthews opened this issue Dec 18, 2024 · 0 comments
Open
2 tasks done

Tell users how to get started with the SDK. #289

johnnymatthews opened this issue Dec 18, 2024 · 0 comments

Comments

@johnnymatthews
Copy link
Collaborator

Child of #287

Create a Getting started guide that covers how to install the SDK, configure it, and some basic uses.

Proposed solution

Create a page at /reference/sdk/get-started with the following sections:

  • Installation steps
  • Basic configuration
  • First-time dev walkthrough
    • Define basic use case
    • Set up a test
    • Run the SDK against that test
    • Get an expected output
  • Troubleshooting steps and/or common errors that users may run into.

Checklist

I confirm that I have:

  • Checked to see if there are any existing issue that cover this topic.
  • Linked to any relevant issues across all entropyxyz repos.
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

No branches or pull requests

1 participant