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

chore: isolate API docs #3237

Closed
wants to merge 31 commits into from
Closed

chore: isolate API docs #3237

wants to merge 31 commits into from

Conversation

danielbate
Copy link
Contributor

@danielbate danielbate commented Oct 2, 2024 •
edited by Dhaiwat10
Loading

Summary

Moves the API docs to fuels-ts-docs-api.vercel.app with preview URLs. Also exposed more packages with typedoc.

Screenshot 2024-10-16 at 00 02 09

We have still kept the old API docs in place to facilitate a smoother transition for the docs hub.

Checklist

  • All changes are covered by tests (or not applicable)
  • All changes are documented (or not applicable)
  • I reviewed the entire PR myself (preferably, on GH UI)
  • I described all Breaking Changes (or there's none)

@danielbate danielbate added the chore Issue is a chore label Oct 2, 2024
@danielbate danielbate self-assigned this Oct 2, 2024
@vercel Vercel
Copy link

vercel bot commented Oct 2, 2024 •
edited
Loading

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
fuels-template ❌ Failed (Inspect) Nov 20, 2024 2:34pm
ts-api-docs ❌ Failed (Inspect) Nov 20, 2024 2:34pm
ts-docs ❌ Failed (Inspect) Nov 20, 2024 2:34pm
1 Skipped Deployment
Name Status Preview Comments Updated (UTC)
ts-docs-api ⬜️ Ignored (Inspect) Visit Preview Nov 20, 2024 2:34pm

@petertonysmith94
Copy link
Contributor

Finally 🙏🏼

@danielbate
Copy link
Contributor Author

danielbate commented Oct 15, 2024 •
edited
Loading

@FuelLabs/sdk-ts leaving this as draft until we have a new vercel project as we deleted the last one. But the code is ready.

@codspeed-hq CodSpeed HQ
Copy link

codspeed-hq bot commented Oct 15, 2024 •
edited
Loading

CodSpeed Performance Report

Merging #3237 will not alter performance

Comparing db/chore/isolate-api-docs (d4273af) with master (7f92490)

Summary

✅ 18 untouched benchmarks

@danielbate
Copy link
Contributor Author

@Dhaiwat10 is going to take over this in my abcsense.

I've isolated the API docs, but now we need a new project in vercel and to enable the CLI element. We should not do that until we have unfrozen master as it will break CLI.

@danielbate
Copy link
Contributor Author

I think vercel is failing because of this

@github-actions GitHub Actions
Copy link
Contributor

Coverage Report:

Lines Branches Functions Statements
64.2%(+0%) 69.71%(+0%) 72.99%(+0%) 64.64%(+0%)
Changed Files:

Coverage values did not change👌.

@danielbate
Copy link
Contributor Author

Superceded by #3413, explanation here.

@danielbate danielbate closed this Nov 20, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@petertonysmith94 petertonysmith94 petertonysmith94 left review comments

@digorithm digorithm Awaiting requested review from digorithm digorithm is a code owner

@arboleya arboleya Awaiting requested review from arboleya arboleya is a code owner

@Torres-ssf Torres-ssf Awaiting requested review from Torres-ssf Torres-ssf is a code owner

@Dhaiwat10 Dhaiwat10 Awaiting requested review from Dhaiwat10 Dhaiwat10 is a code owner

@nedsalk nedsalk Awaiting requested review from nedsalk nedsalk is a code owner

@maschad maschad Awaiting requested review from maschad maschad is a code owner

Assignees

@danielbate danielbate

@Dhaiwat10 Dhaiwat10

Labels
chore Issue is a chore
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Consider moving ApiDocs outside of the documentation.
4 participants
@danielbate @petertonysmith94 @Dhaiwat10 @Torres-ssf