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

docs: migrated provider docs snippets #3357

Merged
merged 29 commits into from
Oct 30, 2024
Merged

docs: migrated provider docs snippets #3357

merged 29 commits into from
Oct 30, 2024

Conversation

petertonysmith94
Copy link
Contributor

@petertonysmith94 petertonysmith94 commented Oct 24, 2024 •
edited by fuel-service-user
Loading

Summary

  • Migrated provider docs snippets.
  • I added the PageInfo type as an export from the provider.

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)

@petertonysmith94
docs: moved provider options docs snippets
381782a
@petertonysmith94
docs: moved provider instantiation docs snippets
7e67611
@petertonysmith94
docs: moved provider getBaseAssetId docs snippets
9caeab4
@petertonysmith94
docs: removed un-used provider.test.ts docs snippets
b3bac52
@petertonysmith94
docs: moved provider getCoins docs snippets
f1ac271
@petertonysmith94
docs: removed /guide from snippet imports
e2cfe57
@petertonysmith94
docs: moved provider getResourcesToSpend docs snippets
a183f92
@petertonysmith94
docs: moved provider getBalances docs snippets
b914fcf
@petertonysmith94
docs: moved provider getBlocks docs snippets
d5a69d6
@petertonysmith94
docs: moved provider getMessages docs snippets
cbd0cf3
@petertonysmith94
docs: moved provider getMessageByNonce docs snippets
c4c9cc8
@petertonysmith94
docs: moved provider getMessageProof docs snippets
dda2a22
@petertonysmith94
docs: moved provider getTransactions docs snippets
98ca05d
@petertonysmith94
feat: export PageInfo from Provider class
c305d41
@petertonysmith94
docs: moved provider pagination docs snippets
9a18929
@petertonysmith94
chore: changeset
33e0052
@petertonysmith94 petertonysmith94 added the docs Requests pertinent to documentation label Oct 24, 2024
@petertonysmith94 petertonysmith94 self-assigned this Oct 24, 2024
@vercel Vercel
Copy link

vercel bot commented Oct 24, 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 Oct 30, 2024 9:47am
ts-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Oct 30, 2024 9:47am
1 Skipped Deployment
Name Status Preview Comments Updated (UTC)
ts-docs-api ⬜️ Ignored (Inspect) Oct 30, 2024 9:47am

@petertonysmith94 petertonysmith94 changed the title Ps/docs/migrate guide provider docs: migrated provider docs snippets Oct 24, 2024
@codspeed-hq CodSpeed HQ
Copy link

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

CodSpeed Performance Report

Merging #3357 will not alter performance

Comparing ps/docs/migrate-guide-provider (f5a23aa) with master (f1500e4)

Summary

✅ 18 untouched benchmarks

@petertonysmith94 petertonysmith94 enabled auto-merge (squash) October 29, 2024 12:40
maschad
maschad reviewed Oct 29, 2024
View reviewed changes
Copy link
Member

@maschad maschad left a comment

Choose a reason for hiding this comment

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

LGTM but left some comments

apps/docs-snippets2/src/provider/functionality-get-coins.ts Outdated Show resolved Hide resolved
apps/docs-snippets2/src/provider/functionality-get-message-proof.ts Outdated Show resolved Hide resolved
apps/docs-snippets2/src/provider/functionality-get-transactions.ts Outdated Show resolved Hide resolved
@petertonysmith94 petertonysmith94 dismissed stale reviews from Dhaiwat10 and nedsalk via 967d76d October 29, 2024 16:12
@github-actions GitHub Actions
Copy link
Contributor

Coverage Report:

Lines Branches Functions Statements
69.28%(-0.98%) 69.84%(-0.13%) 74.33%(-0.18%) 69.6%(-0.96%)
Changed Files:
Ok File (✨=New File) Lines Branches Functions Statements
🔴 ✨ apps/docs-snippets2/src/provider/pagination.ts 0%
(+0%)		 0%
(+0%)		 100%
(+100%)		 0%
(+0%)
🔴 ✨ apps/docs-snippets2/src/provider/provider-instantiation.ts 0%
(+0%)		 100%
(+100%)		 100%
(+100%)		 0%
(+0%)
🔴 ✨ apps/docs-snippets2/src/provider/provider-operations.ts 0%
(+0%)		 100%
(+100%)		 100%
(+100%)		 0%
(+0%)
🔴 ✨ apps/docs-snippets2/src/provider/provider-options.ts 0%
(+0%)		 100%
(+100%)		 0%
(+0%)		 0%
(+0%)
🔴 ✨ apps/docs-snippets2/src/provider/functionality/get-balances.ts 0%
(+0%)		 100%
(+100%)		 100%
(+100%)		 0%
(+0%)
🔴 ✨ apps/docs-snippets2/src/provider/functionality/get-base-asset-id.ts 0%
(+0%)		 100%
(+100%)		 100%
(+100%)		 0%
(+0%)
🔴 ✨ apps/docs-snippets2/src/provider/functionality/get-blocks.ts 0%
(+0%)		 100%
(+100%)		 100%
(+100%)		 0%
(+0%)
🔴 ✨ apps/docs-snippets2/src/provider/functionality/get-coins-from-account.ts 0%
(+0%)		 100%
(+100%)		 100%
(+100%)		 0%
(+0%)
🔴 ✨ apps/docs-snippets2/src/provider/functionality/get-coins-from-provider.ts 0%
(+0%)		 100%
(+100%)		 100%
(+100%)		 0%
(+0%)
🔴 ✨ apps/docs-snippets2/src/provider/functionality/get-message-proof-block-height.ts 0%
(+0%)		 100%
(+100%)		 100%
(+100%)		 0%
(+0%)
🔴 ✨ apps/docs-snippets2/src/provider/functionality/get-message-proof-block-id.ts 0%
(+0%)		 100%
(+100%)		 100%
(+100%)		 0%
(+0%)
🔴 ✨ apps/docs-snippets2/src/provider/functionality/get-messages-by-nonce.ts 0%
(+0%)		 100%
(+100%)		 100%
(+100%)		 0%
(+0%)
🔴 ✨ apps/docs-snippets2/src/provider/functionality/get-messages.ts 0%
(+0%)		 100%
(+100%)		 100%
(+100%)		 0%
(+0%)
🔴 ✨ apps/docs-snippets2/src/provider/functionality/get-resources-to-spend-from-account.ts 0%
(+0%)		 100%
(+100%)		 100%
(+100%)		 0%
(+0%)
🔴 ✨ apps/docs-snippets2/src/provider/functionality/get-resources-to-spend-from-provider.ts 0%
(+0%)		 100%
(+100%)		 100%
(+100%)		 0%
(+0%)
🔴 ✨ apps/docs-snippets2/src/provider/functionality/get-transactions.ts 0%
(+0%)		 100%
(+100%)		 100%
(+100%)		 0%
(+0%)
🔴 packages/account/src/providers/transaction-request/transaction-request.ts 88.57%
(+0%)		 76.71%
(-1.37%)		 84%
(+0%)		 88.81%
(+0%)

@petertonysmith94 petertonysmith94 merged commit c009812 into master Oct 30, 2024
25 checks passed
@petertonysmith94 petertonysmith94 deleted the ps/docs/migrate-guide-provider branch October 30, 2024 10:08
@fuel-service-user fuel-service-user mentioned this pull request Oct 30, 2024
Merged
Dhaiwat10 pushed a commit that referenced this pull request Nov 19, 2024
@petertonysmith94 @Dhaiwat10
docs: migrated provider docs snippets (#3357)
d67540f 
* docs: moved provider options docs snippets

* docs: moved provider instantiation docs snippets

* docs: moved provider getBaseAssetId docs snippets

* docs: removed un-used provider.test.ts docs snippets

* docs: moved provider getCoins docs snippets

* docs: removed /guide from snippet imports

* docs: moved provider getResourcesToSpend docs snippets

* docs: moved provider getBalances docs snippets

* docs: moved provider getBlocks docs snippets

* docs: moved provider getMessages docs snippets

* docs: moved provider getMessageByNonce docs snippets

* docs: moved provider getMessageProof docs snippets

* docs: moved provider getTransactions docs snippets

* feat: export `PageInfo` from `Provider` class

* docs: moved provider pagination docs snippets

* chore: changeset

* docs: finalize the migration of provider snippets

* chore: fixing tests

* docs: fixed getMessageProof tests

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

@Dhaiwat10 Dhaiwat10 Dhaiwat10 approved these changes

@Torres-ssf Torres-ssf Torres-ssf approved these changes

@maschad maschad maschad approved these changes

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

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

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

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

Assignees

@petertonysmith94 petertonysmith94

Labels
docs Requests pertinent to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Migrate snippets from guide/provider
5 participants
@petertonysmith94 @Torres-ssf @maschad @nedsalk @Dhaiwat10