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.

Sign up for GitHub

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

Jump to bottom

Consider moving ApiDocs outside of the documentation. #3058

Open
2 of 4 tasks
petertonysmith94 opened this issue Aug 29, 2024 · 1 comment · May be fixed by #3416
Open
2 of 4 tasks

Consider moving ApiDocs outside of the documentation. #3058

petertonysmith94 opened this issue Aug 29, 2024 · 1 comment · May be fixed by #3416
Assignees
@danielbate @Dhaiwat10
Labels
chore Issue is a chore docs Requests pertinent to documentation

Comments

@petertonysmith94
Copy link
Contributor

petertonysmith94 commented Aug 29, 2024 •
edited by danielbate
Loading

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
@petertonysmith94 petertonysmith94 added chore Issue is a chore docs Requests pertinent to documentation labels Aug 29, 2024
@petertonysmith94 petertonysmith94 mentioned this issue Aug 29, 2024
Closed
@arboleya arboleya added temp-p2 and removed temp-M labels Sep 7, 2024
@arboleya arboleya added the temp:notion label Sep 8, 2024 — with Linear
@arboleya arboleya added the temp-linear label Sep 8, 2024 — with Linear
@danielbate danielbate self-assigned this Oct 2, 2024
@danielbate danielbate mentioned this issue Oct 2, 2024
Closed
4 tasks
@danielbate danielbate mentioned this issue Nov 20, 2024
Merged
4 tasks
@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.

@danielbate danielbate linked a pull request Nov 22, 2024 that will close this issue
Draft
4 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@danielbate danielbate

@Dhaiwat10 Dhaiwat10

Labels
chore Issue is a chore docs Requests pertinent to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

chore: remove legacy API docs FuelLabs/fuels-ts
chore: isolate API docs FuelLabs/fuels-ts
4 participants
@arboleya @danielbate @petertonysmith94 @Dhaiwat10