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

task(devx): Update TS SDK docs #3955

Merged
merged 23 commits into from
Nov 15, 2024
Merged

task(devx): Update TS SDK docs #3955

merged 23 commits into from
Nov 15, 2024

Conversation

lucas-tortora
Copy link
Contributor

@lucas-tortora lucas-tortora commented Nov 7, 2024 •
edited
Loading

Description of change

  • replaced signTransactionBlock with signTransaction in examples
  • replaced signAndExecuteTransactionBlock with signAndExecuteTransaction in examples
  • replaced fromHEX with fromHex` in examples
  • replaced toHEX with toHex` in examples
  • replaced TransactionBlock with Transaction in examples
  • replaced tx with txb in examples
  • replaced fromB64 with fromBase64 in examples
  • removed refs to deprecated methods that were delted in refactor(sdk): Remove deprecated sdk wallet standard methods #3560
  • updated bcs examples
  • added useReportTransactionEffects doc
  • added useSignAndExecuteTransaction doc
  • added useSignTransaction doc
  • deleted useSignTransactionBlock doc
  • deleted useSignAndExecuteTransactionBlock doc
  • replaced requiredFeatures with walletFilters in wallet-provider.mdx
  • added fromSecretKey example to keypairs.mdx
  • added doc for Transaction Executors
  • added doc for Transaction Plugins
  • added doc for GraphQL
  • added rate limit warning in faucet.mdx
  • removed the deprecated classes section in ts sdk index
  • removed fromV1 guide for the Kiosk

Links to any relevant issues

fixes #3800

Type of change

  • Documentation Fix

How the change has been tested

Docs were built locally.

Change checklist

  • I have followed the contribution guidelines for this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • I have added tests that prove my fix is effective or that my feature works
  • I have checked that new and existing unit tests pass locally with my changes

@lucas-tortora
task(devx): Updated BCS docs.
d7b6070 
bcs.array => bcs.fixedArray,
fromB58 => fromBase58
fromB64 => fromBase64
@lucas-tortora
task(devx): Updated dapp Kit docs.
1079582 
added: userReportTransactionEffects, useSignAndExecuteTransaction, useSignTransaction.
removed: useSignAndExecuteTransactionBlock, useSignTransactionBlock
updated: txb to tx in rpc-hooks example; replaced requiredFeatures with walletFilter in wallet-provider
@lucas-tortora
task(devx): Updated kiosk docs.
52a7350 
updated: TransactionBlock to Transaction, signAndExecuteTransactionBlock to signAndExecuteTransaction
@lucas-tortora
task(devx): Updated ts docs. fix dead links and examples. imported ne…
ca36871 
…w hooks, removed deprecated hooks

Added: typescript/executors, graphql, and plugins.
@lucas-tortora
fix(devx): remove deprecated refs
00bae2f
@lucas-tortora lucas-tortora requested a review from a team as a code owner November 7, 2024 19:32
@lucas-tortora lucas-tortora requested a review from a team November 7, 2024 19:32
@github-actions github-actions bot added the documentation Improvements or additions to documentation label Nov 7, 2024
@lucas-tortora lucas-tortora added Type: Documentation tooling Issues related to the Tooling team devx Issues related to the DevX team labels Nov 7, 2024
@lucas-tortora lucas-tortora added this to the Testnet Launch v1.0.0-rc milestone Nov 7, 2024
@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Nov 7, 2024

✅ Vercel Preview Deployment is ready!

View Preview

@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Nov 8, 2024

✅ Vercel Preview Deployment is ready!

View Preview

@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Nov 8, 2024

✅ Vercel Preview Deployment is ready!

View Preview

@github-actions GitHub Actions
Copy link
Contributor

✅ Vercel Preview Deployment is ready!

View Preview

marc2332
marc2332 requested changes Nov 12, 2024
View reviewed changes
Copy link
Contributor

@marc2332 marc2332 left a comment

Choose a reason for hiding this comment

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

Some parts of the docs seem to be formatted with tabs and other with spaces, can you format everything with spaces? 🙏🏻

@marc2332
Copy link
Contributor

You also got some conflicts now

@lucas-tortora
Copy link
Contributor Author

You also got some conflicts now

Yeah, it's conflict week for the docs. Too many updates at once.

salaheldinsoliman
salaheldinsoliman approved these changes Nov 12, 2024
View reviewed changes
Copy link
Contributor

@salaheldinsoliman salaheldinsoliman left a comment •
edited
Loading

Choose a reason for hiding this comment

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

Looks great, just a few suggestions

docs/content/references/ts-sdk/dapp-kit/wallet-hooks/useReportTransactionEffects.mdx Outdated Show resolved Hide resolved
docs/content/references/ts-sdk/dapp-kit/wallet-hooks/useSignAndExecuteTransaction.mdx Outdated Show resolved Hide resolved
docs/content/references/ts-sdk/dapp-kit/wallet-hooks/useSignAndExecuteTransaction.mdx Outdated Show resolved Hide resolved
docs/content/references/ts-sdk/dapp-kit/wallet-hooks/useSignTransaction.mdx Outdated Show resolved Hide resolved
docs/content/references/ts-sdk/dapp-kit/wallet-hooks/useSignTransaction.mdx Outdated Show resolved Hide resolved
docs/content/references/ts-sdk/typescript/plugins.mdx Outdated Show resolved Hide resolved
docs/content/references/ts-sdk/typescript/plugins.mdx Outdated Show resolved Hide resolved
@github-actions GitHub Actions
Copy link
Contributor

✅ Vercel Preview Deployment is ready!

View Preview

@github-actions GitHub Actions
Copy link
Contributor

✅ Vercel Preview Deployment is ready!

View Preview

@github-actions GitHub Actions
Copy link
Contributor

✅ Vercel Preview Deployment is ready!

View Preview

@github-actions GitHub Actions
Copy link
Contributor

✅ Vercel Preview Deployment is ready!

View Preview

@lucas-tortora
Copy link
Contributor Author

@begonaalvarezd, @marc2332 and @vivekjain23 , I've addressed all the comments, please take another look so we can, ideally, merge this

@github-actions GitHub Actions
Copy link
Contributor

✅ Vercel Preview Deployment is ready!

View Preview

@github-actions GitHub Actions
Copy link
Contributor

✅ Vercel Preview Deployment is ready!

View Preview

@github-actions GitHub Actions
Copy link
Contributor

✅ Vercel Preview Deployment is ready!

View Preview

vivekjain23
vivekjain23 approved these changes Nov 15, 2024
View reviewed changes
Copy link
Contributor

@vivekjain23 vivekjain23 left a comment

Choose a reason for hiding this comment

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

Minor changes are required.

docs/content/references/ts-sdk/dapp-kit/wallet-hooks/useSignTransaction.mdx Outdated Show resolved Hide resolved
docs/content/references/ts-sdk/dapp-kit/wallet-hooks/useSignAndExecuteTransaction.mdx Outdated Show resolved Hide resolved
docs/content/references/ts-sdk/typescript/owned-object-pool/overview.mdx Show resolved Hide resolved
marc2332
marc2332 approved these changes Nov 15, 2024
View reviewed changes
Copy link
Contributor

@marc2332 marc2332 left a comment

Choose a reason for hiding this comment

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

lgtm for me, just needs to fix what was requested above 👆🏻

@github-actions GitHub Actions
Copy link
Contributor

✅ Vercel Preview Deployment is ready!

View Preview

@lucas-tortora lucas-tortora merged commit 0f6ff19 into develop Nov 15, 2024
33 of 34 checks passed
@lucas-tortora lucas-tortora deleted the devx/update-ts-docs branch November 15, 2024 15:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@vivekjain23 vivekjain23 vivekjain23 approved these changes

@marc2332 marc2332 marc2332 approved these changes

@Ginowine Ginowine Ginowine approved these changes

@Dr-Electron Dr-Electron Awaiting requested review from Dr-Electron

@salaheldinsoliman salaheldinsoliman Awaiting requested review from salaheldinsoliman

@begonaalvarezd begonaalvarezd Awaiting requested review from begonaalvarezd

Assignees
No one assigned
Labels
devx Issues related to the DevX team documentation Improvements or additions to documentation tooling Issues related to the Tooling team
Projects
Developer Experience
Status: Done
Milestone
Testnet Launch v0.7.x-rc
Development

Successfully merging this pull request may close these issues.

Update TS docs
6 participants
@lucas-tortora @marc2332 @begonaalvarezd @Ginowine @salaheldinsoliman @vivekjain23