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

Open
wants to merge 18 commits into
base: master
Choose a base branch
from
Open

chore: isolate API docs #3237

wants to merge 18 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 ✅ Ready (Inspect) Visit Preview 💬 Add feedback Nov 9, 2024 7:26am
ts-api-docs ❌ Failed (Inspect) Nov 9, 2024 7:26am
ts-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Nov 9, 2024 7:26am
1 Skipped Deployment
Name Status Preview Comments Updated (UTC)
ts-docs-api ⬜️ Ignored (Inspect) Visit Preview Nov 9, 2024 7:26am

@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 (84b1cb5) with master (9dd92de)

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.

This was referenced Oct 24, 2024
Merged
Draft
@Dhaiwat10
Copy link
Member

Need to get these two PRs merged in order for CI to pass:

FuelLabs/github-actions#43
FuelLabs/docs-hub#485

Dhaiwat10 added a commit to FuelLabs/github-actions that referenced this pull request Oct 24, 2024
@Dhaiwat10
chore: remove docs validation for ts sdk api docs (#43)
1c646b5 
This PR removes the validation in place for the TS SDK API docs since
they have now been isolated in a different project on a different URL
(FuelLabs/fuels-ts#3237) and they are now only
referenced from the 'main' TS SDK docs.
@petertonysmith94
Copy link
Contributor

Update Vercel to ignore this deployment (temporarily)

@Dhaiwat10 Dhaiwat10 marked this pull request as ready for review October 29, 2024 09:48
petertonysmith94
petertonysmith94 reviewed Oct 29, 2024
View reviewed changes
Copy link
Contributor

@petertonysmith94 petertonysmith94 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Potentially, instead of Closing the issue, we could make it related to it, then in our subsequent PR for full integration, can we close it?

  • I think we should leave the changes to the docs URLs till the subsequent PR.
  • We may want to add to the package path in scripts/lint-md-links.ts.
    The generated files from apps/docs-api/src/api/media are currently failing the linting step.

apps/docs-api/typedoc.json Show resolved Hide resolved
.github/workflows/release.yaml Show resolved Hide resolved
apps/docs-api/package.json Show resolved Hide resolved
@Dhaiwat10
Copy link
Member

I think we should leave the changes to the docs URLs till the subsequent PR.

A counter argument to this could be that if we swap out the URLs now, we can enable a smoother transition by testing thew new API docs in production and see if we face any issues. 👀 Rather than rolling out the whole thing at once without having had it tested by users in prod at all

@github-actions GitHub Actions
Copy link
Contributor

Coverage Report:

Lines Branches Functions Statements
70.9%(-1.97%) 69.95%(-0.29%) 74.46%(-0.17%) 71.19%(-1.94%)
Changed Files:
Ok File (✨=New File) Lines Branches Functions Statements
🔴 ✨ apps/docs-snippets2/src/create-fuels/decrement-counter.ts 0%
(+0%)		 100%
(+100%)		 100%
(+100%)		 0%
(+0%)
🔴 ✨ apps/docs-snippets2/src/encoding/encode-and-decode.ts 0%
(+0%)		 100%
(+100%)		 0%
(+0%)		 0%
(+0%)
🔴 ✨ apps/docs-snippets2/src/encoding/working-with-bytes.ts 0%
(+0%)		 100%
(+100%)		 100%
(+100%)		 0%
(+0%)
🔴 ✨ apps/docs-snippets2/src/scripts/deploying-scripts.ts 0%
(+0%)		 100%
(+100%)		 100%
(+100%)		 0%
(+0%)
🔴 ✨ apps/docs-snippets2/src/scripts/script-custom-transaction.ts 0%
(+0%)		 100%
(+100%)		 100%
(+100%)		 0%
(+0%)
🔴 ✨ apps/docs-snippets2/src/scripts/script-with-configurable.ts 0%
(+0%)		 100%
(+100%)		 100%
(+100%)		 0%
(+0%)
🔴 ✨ apps/docs-snippets2/src/testing/launching-a-test-node.ts 0%
(+0%)		 100%
(+100%)		 100%
(+100%)		 0%
(+0%)
🔴 ✨ apps/docs-snippets2/src/testing/tweaking-the-blockchain.ts 0%
(+0%)		 0%
(+0%)		 100%
(+100%)		 0%
(+0%)
🔴 ✨ apps/docs-snippets2/src/typegend/predicates/SimplePredicateLoader.ts 80%
(+80%)		 100%
(+100%)		 0%
(+0%)		 80%
(+80%)
✅ apps/docs-snippets2/src/typegend/scripts/ScriptSum.ts 100%
(+20%)		 100%
(+0%)		 100%
(+100%)		 100%
(+20%)
✅ ✨ apps/docs-snippets2/src/typegend/scripts/ScriptSumLoader.ts 100%
(+100%)		 100%
(+100%)		 100%
(+100%)		 100%
(+100%)
🔴 ✨ apps/docs-snippets2/src/typegend/scripts/ScriptTransferToContract.ts 80%
(+80%)		 100%
(+100%)		 0%
(+0%)		 80%
(+80%)
🔴 ✨ apps/docs-snippets2/src/typegend/scripts/ScriptTransferToContractLoader.ts 80%
(+80%)		 100%
(+100%)		 0%
(+0%)		 80%
(+80%)
🔴 ✨ apps/docs-snippets2/src/utilities/unit-conversion.ts 0%
(+0%)		 100%
(+100%)		 100%
(+100%)		 0%
(+0%)
🔴 ✨ apps/docs-snippets2/src/wallet-manager/getting-started-with-wallet-manager.ts 0%
(+0%)		 100%
(+100%)		 100%
(+100%)		 0%
(+0%)
🔴 ✨ apps/docs-snippets2/src/wallet-manager/locking-and-unlocking-wallet-manager.ts 0%
(+0%)		 100%
(+100%)		 100%
(+100%)		 0%
(+0%)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@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

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

At least 3 approving reviews are required to merge this pull request.

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