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 predicate docs snippets #3358

Merged
merged 18 commits into from
Nov 8, 2024
Merged

docs: migrated predicate docs snippets #3358

merged 18 commits into from
Nov 8, 2024

Conversation

petertonysmith94
Copy link
Contributor

@petertonysmith94 petertonysmith94 commented Oct 25, 2024 •
edited
Loading

Summary

  • Migrated predicate docs snippets

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 petertonysmith94 added the docs Requests pertinent to documentation label Oct 25, 2024
@petertonysmith94 petertonysmith94 self-assigned this Oct 25, 2024
@vercel Vercel
Copy link

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

@codspeed-hq CodSpeed HQ
Copy link

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

CodSpeed Performance Report

Merging #3358 will not alter performance

Comparing ps/docs/migrate-guide-predicate (afcecc2) with master (4e057d5)

Summary

✅ 18 untouched benchmarks

@petertonysmith94 petertonysmith94 changed the title docs: migrate guide predicate docs: migrated predicate docs snippets Oct 25, 2024
@petertonysmith94 petertonysmith94 marked this pull request as ready for review October 29, 2024 13:14
@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Nov 6, 2024

Coverage Report:

Lines Branches Functions Statements
67.5%(-1.23%) 69.75%(-0.03%) 74.12%(-0.17%) 67.85%(-1.2%)
Changed Files:
Ok File (✨=New File) Lines Branches Functions Statements
🔴 ✨ apps/docs-snippets2/src/predicates/custom-transactions.ts 0%
(+0%)		 100%
(+100%)		 100%
(+100%)		 0%
(+0%)
🔴 ✨ apps/docs-snippets2/src/predicates/deploying-predicates.ts 0%
(+0%)		 100%
(+100%)		 100%
(+100%)		 0%
(+0%)
🔴 ✨ apps/docs-snippets2/src/predicates/configurables/configurable-default.ts 0%
(+0%)		 100%
(+100%)		 100%
(+100%)		 0%
(+0%)
🔴 ✨ apps/docs-snippets2/src/predicates/configurables/configurable-set-data.ts 0%
(+0%)		 100%
(+100%)		 100%
(+100%)		 0%
(+0%)
🔴 ✨ apps/docs-snippets2/src/predicates/cookbook/failure-not-enough-funds.ts 0%
(+0%)		 100%
(+100%)		 0%
(+0%)		 0%
(+0%)
🔴 ✨ apps/docs-snippets2/src/predicates/cookbook/failure-returns-false.ts 0%
(+0%)		 100%
(+100%)		 0%
(+0%)		 0%
(+0%)
🔴 ✨ apps/docs-snippets2/src/predicates/cookbook/pre-stage.ts 0%
(+0%)		 100%
(+100%)		 100%
(+100%)		 0%
(+0%)
🔴 ✨ apps/docs-snippets2/src/predicates/cookbook/transferring-assets.ts 0%
(+0%)		 100%
(+100%)		 100%
(+100%)		 0%
(+0%)
🔴 ✨ apps/docs-snippets2/src/predicates/instantiation/multi-args.ts 0%
(+0%)		 100%
(+100%)		 100%
(+100%)		 0%
(+0%)
🔴 ✨ apps/docs-snippets2/src/predicates/instantiation/simple.ts 0%
(+0%)		 100%
(+100%)		 100%
(+100%)		 0%
(+0%)
🔴 ✨ apps/docs-snippets2/src/predicates/instantiation/struct-arg.ts 0%
(+0%)		 100%
(+100%)		 100%
(+100%)		 0%
(+0%)
🔴 ✨ apps/docs-snippets2/src/predicates/methods/create-transfer.ts 0%
(+0%)		 100%
(+100%)		 100%
(+100%)		 0%
(+0%)
🔴 ✨ apps/docs-snippets2/src/predicates/methods/get-resources-to-spend.ts 0%
(+0%)		 100%
(+100%)		 100%
(+100%)		 0%
(+0%)
🔴 ✨ apps/docs-snippets2/src/predicates/methods/send-transaction.ts 0%
(+0%)		 100%
(+100%)		 100%
(+100%)		 0%
(+0%)
🔴 ✨ apps/docs-snippets2/src/predicates/methods/simulate-transaction.ts 0%
(+0%)		 100%
(+100%)		 0%
(+0%)		 0%
(+0%)
🔴 ✨ apps/docs-snippets2/src/predicates/methods/transfer.ts 0%
(+0%)		 100%
(+100%)		 100%
(+100%)		 0%
(+0%)
✅ ✨ apps/docs-snippets2/src/typegend/predicates/ConfigurablePin.ts 100%
(+100%)		 100%
(+100%)		 100%
(+100%)		 100%
(+100%)
✅ ✨ apps/docs-snippets2/src/typegend/predicates/ConfigurablePinLoader.ts 100%
(+100%)		 100%
(+100%)		 100%
(+100%)		 100%
(+100%)
✅ ✨ apps/docs-snippets2/src/typegend/predicates/PredicateMainArgsStruct.ts 100%
(+100%)		 100%
(+100%)		 100%
(+100%)		 100%
(+100%)
🔴 ✨ apps/docs-snippets2/src/typegend/predicates/PredicateMainArgsStructLoader.ts 80%
(+80%)		 100%
(+100%)		 0%
(+0%)		 80%
(+80%)
✅ ✨ apps/docs-snippets2/src/typegend/predicates/PredicateMultiArgs.ts 100%
(+100%)		 100%
(+100%)		 100%
(+100%)		 100%
(+100%)
🔴 ✨ apps/docs-snippets2/src/typegend/predicates/PredicateMultiArgsLoader.ts 80%
(+80%)		 100%
(+100%)		 0%
(+0%)		 80%
(+80%)
✅ ✨ apps/docs-snippets2/src/typegend/predicates/ReturnTruePredicate.ts 100%
(+100%)		 100%
(+100%)		 100%
(+100%)		 100%
(+100%)
🔴 ✨ apps/docs-snippets2/src/typegend/predicates/ReturnTruePredicateLoader.ts 80%
(+80%)		 100%
(+100%)		 0%
(+0%)		 80%
(+80%)
✅ apps/docs-snippets2/src/typegend/predicates/SimplePredicate.ts 100%
(+20%)		 100%
(+0%)		 100%
(+100%)		 100%
(+20%)
✅ ✨ apps/docs-snippets2/src/typegend/predicates/WhitelistedAddressPredicate.ts 100%
(+100%)		 100%
(+100%)		 100%
(+100%)		 100%
(+100%)
🔴 ✨ apps/docs-snippets2/src/typegend/predicates/WhitelistedAddressPredicateLoader.ts 80%
(+80%)		 100%
(+100%)		 0%
(+0%)		 80%
(+80%)
🔴 packages/account/src/providers/transaction-request/transaction-request.ts 88.57%
(+0%)		 76.71%
(-1.37%)		 84%
(+0%)		 88.81%
(+0%)

@petertonysmith94 petertonysmith94 enabled auto-merge (squash) November 8, 2024 06:17
@petertonysmith94 petertonysmith94 merged commit 9dd92de into master Nov 8, 2024
25 checks passed
@petertonysmith94 petertonysmith94 deleted the ps/docs/migrate-guide-predicate branch November 8, 2024 06:19
Dhaiwat10 pushed a commit that referenced this pull request Nov 19, 2024
@petertonysmith94 @arboleya @Dhaiwat10
docs: migrated predicate docs snippets (#3358)
f079ccd 
* docs: moved predicate configurable docs snippets

* docs: moved predicate deployment docs snippets

* docs: moved predicate transactions docs snippets

* docs: moved predicate deploying docs snippets

* docs: moved predicate instantiation docs snippets

* docs: moved predicate methods (`getResourcesToSpend`) docs snippets

* docs: moved predicate methods (`sendTransaction`) docs snippets

* docs: moved predicate methods (`simulateTransaction`) docs snippets

* docs: moved predicate methods (`createTransfer`) docs snippets

* docs: moved predicate methods (`transfer`) docs snippets

* docs: moved predicate send and spend funds docs snippets

* docs: fixed all predicate method snippets

* chore: lintfix

* chore: revert changes to proxy contract

* changeset

---------

Co-authored-by: Anderson Arboleya <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@arboleya arboleya arboleya approved these changes

@danielbate danielbate danielbate approved these changes

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

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

@Dhaiwat10 Dhaiwat10 Awaiting requested review from Dhaiwat10

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

@maschad maschad Awaiting requested review from maschad

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/predicates
4 participants
@petertonysmith94 @arboleya @danielbate @Torres-ssf