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

Minor Documentation Tweaks and Suggestions #36

Open
muharem opened this issue Dec 4, 2024 · 1 comment
Open

Minor Documentation Tweaks and Suggestions #36

muharem opened this issue Dec 4, 2024 · 1 comment

Comments

@muharem
Copy link

muharem commented Dec 4, 2024

After reading the documentation, which feels overall well-structured and clear, I wanted to share a few minor findings. If this isn’t useful, feel free to close the issue.

  • It’s currently possible to set up and deploy contracts locally using contracts-boilerplate, but the docs say otherwise:
    To keep things simple for now, you need to use our [REMIX](https://remix.polkadot.io) web frontend to compile
  • The tutorial suggests using kitchensink for local setup, but I ran into some issues with certain functionality not working or the runtime code blob being too large. Using the Westend Asset Hub locally might be a more stable alternative and identical to what suggested as a non-local env.
  • The reference page for sys calls is only mentioned once in the text. Maybe it would be useful to link it in the navigation menu?
  • The link for sys calls docs seems to point to an outdated page that suggests the uapi docs for every call. The uapi docs seem to be brocken - https://docs.rs/crate/pallet-revive-uapi/0.1.1:
    [here](https://docs.rs/pallet-revive/latest/pallet_revive/trait.SyscallDoc.html). This is a custom instruction that doesn't exist in RISC-V. We replaced the
  • In the docs for storage-related sys calls, it might be worth mentioning that they only concern contract storage and don’t provide access to runtime storage.
  • The contracts-boilerplate suggests using bun instead of node/npm, which might be less user-friendly given that node/npm remains the most widely used tool. Additionally, the REMIX Tips section in the documentation provides examples using npm.
@athei
Copy link
Member

athei commented Dec 10, 2024

Thanks for the suggestion. Makes sense to me. Just need to make sure when I get to fixing it.

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

No branches or pull requests

2 participants