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
Currently our API docs are appended to our handcrafted documentation (example). This has been the source of a couple of issues and it is aesthetically unappealing in the docs-hub. We should explore the possibility of hosting this ourself (via Vercel perhaps), and adding a reference to this (like the Rust SDK does here).
Deploy ApiDocs
Add reference within our docs to this new deployment
Remove all legacy resources that enabled this process
Ensure compatibility with the docs-hub
The text was updated successfully, but these errors were encountered:
@petertonysmith94 suggested a smarter, phased approach which will allow us to not break the link CI stage. So in this PR we will ship the API docs, and in a follow-up we will remove the existing API doc code and move links to the shipped API doc URL.
Summary
Currently our API docs are appended to our handcrafted documentation (example). This has been the source of a couple of issues and it is aesthetically unappealing in the docs-hub. We should explore the possibility of hosting this ourself (via Vercel perhaps), and adding a reference to this (like the Rust SDK does here).
ApiDocs
docs-hub
The text was updated successfully, but these errors were encountered: