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

Create an SDK reference #238

Closed
1 task
OisinKyne opened this issue Jul 31, 2023 · 1 comment
Closed
1 task

Create an SDK reference #238

OisinKyne opened this issue Jul 31, 2023 · 1 comment
Assignees
Labels
candidate documentation Improvements or additions to documentation launchpad

Comments

@OisinKyne
Copy link
Contributor

OisinKyne commented Jul 31, 2023

🎯 Problem to be solved

We have a quickstart for the SDK, but no comprehensive reference of its features. This means people need to read the source code of the SDK (which is still private) to see what it does.

🛠️ Proposed solution

Export typedoc from the SDK, and include it in our docusaurus site the same way we have incorporated a swagger spec.

If unfeasible we can do it manually, but that is plan b and needs a verbal confirmation that we are going that route.

🧪 Tests

  • Netlify deployment build tests passing

👐 Additional acceptance criteria

The typedoc artifact is exported from obol-packages CI/CD, and is pulled into the docs repo in an automated fashion, meaning it never gets stale (like the current swagger spec does)

❌ Out of Scope

Finishing the quickstart guide

@boulder225 boulder225 added launchpad documentation Improvements or additions to documentation candidate labels Aug 2, 2023
@boulder225
Copy link
Contributor

Hey team! Please add your planning poker estimate with Zenhub @f1lander @HananINouman

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
candidate documentation Improvements or additions to documentation launchpad
Projects
None yet
Development

No branches or pull requests

3 participants