Skip to content

Minor Documentation Tweaks and Suggestions #36

@muharem

Description

@muharem

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.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions