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

Consider moving ApiDocs outside of the documentation. #3058

Open
2 of 4 tasks
petertonysmith94 opened this issue Aug 29, 2024 · 1 comment
Open
2 of 4 tasks

Consider moving ApiDocs outside of the documentation. #3058

petertonysmith94 opened this issue Aug 29, 2024 · 1 comment
Assignees
Labels
chore Issue is a chore docs Requests pertinent to documentation

Comments

@petertonysmith94
Copy link
Contributor

petertonysmith94 commented Aug 29, 2024

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).

  • 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
@danielbate
Copy link
Contributor

@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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
chore Issue is a chore docs Requests pertinent to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants