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.

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

ISC Restructure - Small Fixes #1498

Merged
merged 5 commits into from
Feb 27, 2024
Merged

Conversation

lucas-tortora
Copy link
Collaborator

Description of change

  • Danger to info in languages and vms
  • Review note in intro about on and off ledger requests, add link to actual explanation
  • double check ShimmerEVM Testnet nomenclature
  • Move test smart contracts down, add examples
  • add link to deploy in basic SC
  • remove highlight ERC721
  • move EVM to top layer (AKA group by intent or topic, rather than VM)
  • rotate full example where it's different
  • tabs in create foundry
  • tabs in mint native tokens
  • review intructions in register-token
  • review headers allowance
  • add warning about ERC20 in getbalance
  • add note about onledger requests on /isc/explanations/invocation/
  • move /isc/explanations/proxies/ to wasm
  • add link to JSON RPC in isc/getting-started/compatibility/#wrapped-calls-to-the-json-rpc

Links to any relevant issues

fixes iotaledger/devx#341

Type of change

  • Documentation Fix

Change checklist

Tick the boxes that are relevant to your changes, and delete any items that are not.

  • I have followed the contribution guidelines for this project
  • I have performed a self-review of my own changes
  • I have made sure that added/changed links still work
  • I have commented my code, particularly in hard-to-understand areas

 Review note in intro about on and off ledger requests, add link to actual explanation
 double check ShimmerEVM Testnet nomenclature
 Move test smart contracts down, add examples
 add link to deploy in basic SC
 remove highlight ERC721
 move EVM to top layer (AKA group by intent or topic, rather than VM)
 rotate full example where it's different
 tabs in create foundry
 tabs in mint native tokens
 review intructions in register-token
 review headers allowance
 add warning about ERC20 in getbalance
 add note about onledger requests on /isc/explanations/invocation/
 move /isc/explanations/proxies/ to wasm
 add link to JSON RPC in isc/getting-started/compatibility/#wrapped-calls-to-the-json-rpc
@lucas-tortora lucas-tortora marked this pull request as ready for review February 27, 2024 18:45
Copy link
Contributor

This pull request has been deployed to Vercel.

Latest commit: e729a17

✅ Preview: https://iota-wiki-dfpp0ibdy-iota1.vercel.app

Copy link
Collaborator

@Dr-Electron Dr-Electron left a comment

Choose a reason for hiding this comment

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

I think the EVM change was not intended that way. @jlvandenhout thought more about a rename.
But in general I think we should rethink that section

@Dr-Electron
Copy link
Collaborator

Dr-Electron commented Feb 27, 2024

I would restructure the sidebar/content like this:

From:

How-Tos
├── About How-to Guides
├── Send Funds From L1 to L2
├── Create a Basic Solidity Contract
├── Deploy a Smart Contract
├── Test Smart Contracts
├── Create Custom Tokens - ERC20
├── Create NFTs - ERC721
└── Use Magit Contract/

To:

How-Tos
├── About How-to Guides
├── Send Funds From L1 to L2
├── Create a Basic Contract // Make the title VM agnostic.
├── Deploy a Smart Contract
├── Test Smart Contracts // This is actually not really a how-to. More of an explanation I guess
└── Use Magit Contract/

@lucas-tortora
Copy link
Collaborator Author

no ERC.. examples?

I would restructure the sidebar/content like this:

From:

How-Tos
├── About How-to Guides
├── Send Funds From L1 to L2
├── Create a Basic Solidity Contract
├── Deploy a Smart Contract
├── Test Smart Contracts
├── Create Custom Tokens - ERC20
├── Create NFTs - ERC721
└── Use Magit Contract/

To:

How-Tos
├── About How-to Guides
├── Send Funds From L1 to L2
├── Create a Basic Contract // Make the title VM agnostic.
├── Deploy a Smart Contract
├── Test Smart Contracts // This is actually not really a how-to. More of an explanation I guess
└── Use Magit Contract/

No Solidity ERC how tos?

@Dr-Electron
Copy link
Collaborator

no ERC.. examples?

I would restructure the sidebar/content like this:
From:

How-Tos
├── About How-to Guides
├── Send Funds From L1 to L2
├── Create a Basic Solidity Contract
├── Deploy a Smart Contract
├── Test Smart Contracts
├── Create Custom Tokens - ERC20
├── Create NFTs - ERC721
└── Use Magit Contract/

To:

How-Tos
├── About How-to Guides
├── Send Funds From L1 to L2
├── Create a Basic Contract // Make the title VM agnostic.
├── Deploy a Smart Contract
├── Test Smart Contracts // This is actually not really a how-to. More of an explanation I guess
└── Use Magit Contract/

No Solidity ERC how tos?

No. As we once said there are tutorials others did better. Our USP is the core contracts basically

@lucas-tortora
Copy link
Collaborator Author

lucas-tortora commented Feb 27, 2024

no ERC.. examples?

I would restructure the sidebar/content like this:
From:

How-Tos
├── About How-to Guides
├── Send Funds From L1 to L2
├── Create a Basic Solidity Contract
├── Deploy a Smart Contract
├── Test Smart Contracts
├── Create Custom Tokens - ERC20
├── Create NFTs - ERC721
└── Use Magit Contract/

To:

How-Tos
├── About How-to Guides
├── Send Funds From L1 to L2
├── Create a Basic Contract // Make the title VM agnostic.
├── Deploy a Smart Contract
├── Test Smart Contracts // This is actually not really a how-to. More of an explanation I guess
└── Use Magit Contract/

No Solidity ERC how tos?

No. As we once said there are tutorials others did better. Our USP is the core contracts basically

That's one way of looking at it. The other is that we should cover the basics. There's a middle ground which would be VM agnostic but cover Solidity as well. That being said, we can probably target that for another iteration and close this huge PR once and for all.

@Dr-Electron Dr-Electron merged commit 77d8576 into ISC/restructure Feb 27, 2024
@Dr-Electron Dr-Electron deleted the ISC/restructure-small-fixes branch February 27, 2024 21:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants