You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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
The text was updated successfully, but these errors were encountered:
🎯 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
👐 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
The text was updated successfully, but these errors were encountered: