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 and Edit docs #1166

Merged
merged 40 commits into from
Sep 22, 2023
Merged

ISC - Restructure and Edit docs #1166

merged 40 commits into from
Sep 22, 2023

Conversation

lucas-tortora
Copy link
Collaborator

@lucas-tortora lucas-tortora commented Sep 12, 2023

Description of change

Restructured ISC docs:

  • Split content from EVM and Wasm.
  • Moved part of wasp-cli to the build section.
  • Reorganized EVM and Wasm content using diataxis for the build and learn sections

Links to any relevant issues

fixes iotaledger/devx#214
fixes iotaledger/devx#213

Type of change

  • Documentation Enhancement

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

@lucas-tortora lucas-tortora marked this pull request as ready for review September 13, 2023 14:44
@lucas-tortora lucas-tortora changed the title ISC - Restructure docs ISC - Restructure and Edit docs Sep 13, 2023
docs/build/wasp-evm/0.7.0/docs/introduction.md Outdated Show resolved Hide resolved
docs/build/wasp-wasm/0.7.0/docs/introduction.mdx Outdated Show resolved Hide resolved
docs/build/wasp-evm/0.7.0/docs/introduction.md Outdated Show resolved Hide resolved
docs/build/wasp-wasm/0.7.0/docs/explanations/concepts.mdx Outdated Show resolved Hide resolved
lucas-tortora and others added 5 commits September 14, 2023 12:16
Added experimental tag to switcher for wasp-wasm
Added links to stardust protocol and shimmer endpoints in emv/intro and wasm/intro
Replaced ShimmerEVM Testnet with Public Testnet and link to networks and endpoints in evm getting-started sections
Added link to off-ledger and on-ledger request explanations in evm-getting/started/compatibility
Removed redundant paragrpah in how-tos/magic-contract/call-a-native-contract
Added link to magic_contract ref in wasp-evm/0.7.0/docs/how-tos/magic-contract/magic.md
Removed redundant explanation in emv/explanations/concepts
Added average block time in evm/compatibility
@Dr-Electron
Copy link
Collaborator

/create-preview

@github-actions
Copy link
Contributor

This pull request has been deployed to Vercel.

Latest commit:

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

docs/build/getting-started/networks-endpoints.md Outdated Show resolved Hide resolved
Comment on lines +63 to +64
Unlike Ethereum's blockchain that houses the state in a Merkle tree, the EVM state resides in a raw form to prevent the
duplication of efforts undertaken by the ISC layer.
Copy link
Collaborator

Choose a reason for hiding this comment

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

@fijter Reminder

fijter
fijter previously approved these changes Sep 21, 2023
Copy link
Contributor

@fijter fijter left a comment

Choose a reason for hiding this comment

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

great improvement 👍

luca-moser
luca-moser previously approved these changes Sep 22, 2023
@luca-moser
Copy link
Member

Please resolve the conflicts so we can get this merged.

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.

We need to add the core contracts to both evm and wasm

@lucas-tortora lucas-tortora dismissed stale reviews from luca-moser and fijter via b5df882 September 22, 2023 13:20
@lucas-tortora
Copy link
Collaborator Author

/create-preview

@github-actions
Copy link
Contributor

This pull request has been deployed to Vercel.

Latest commit:

✅ Preview: https://iota-wiki-4zt5bfvco-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.

Is there a way to make the core contracts be part of both sections without copying them? We should be able to import them in both plugins, no?

Other than that, looks good to me

@lucas-tortora
Copy link
Collaborator Author

Is there a way to make the core contracts be part of both sections without copying them? We should be able to import them in both plugins, no?

Other than that, looks good to me

If they were the same plugin we could use _ for the base and import it in both. I would like to look for a solution, but I wouldn't delay this merge over ~10 duplicate files. We can sort it out in another PR

@lucas-tortora lucas-tortora merged commit 0b95905 into main Sep 22, 2023
11 checks passed
@lucas-tortora lucas-tortora deleted the ISC/restructure-docs branch September 22, 2023 18:00
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.

ISC - reorganize and reformat docs ISC - remove links to wasp.sc.*
4 participants