Skip to content

Improve Current Guides #40

Description

@PiotrNap

Mesh Portal

I am proposing we implement the following changes to the current guides.

Overall

  • - On the new website, icons under the “Guides” dropdown are too small - I think they can be removed
  • - We can create a separate guide dedicated to the environment setup only (Node.js, Aiken, mesh-core), instead of repeating it in multiple guides
  • - Typescript is a bit overkill in examples where it’s not needed. Plain JS is more beginner-friendly
  • - Each guide should have a full working code example on GitHub (not including “Implement Custom Provider” and “Resolve Node-Specific Imports Errors”)

1. Vesting script end-to-end

  • - Provide more general use-cases instead of a single employee/company example
  • - Provide a full code example
  • - Attach urls to GitHub files
  • - Adjust the code snippets so that they match with the code on GitHub
  • - Fix incorrect imports in full code example on GitHub

2. Prove wallet ownership

  • - Shorten the intro
  • - Mention the original technique - “asymmetric message signing”
  • - Improve readability and logical flow
  • - Match the section headers with the steps in the illustration
  • - Cut down unrelated tech details
  • - Make the full implementation example runnable
  • - (Potentially) link to Bonfire app as a real-world example; front-end & back-end

3. Minting application

  • - Explain the formats of parameters and what purpose they serve
  • - Fix broken urls
  • - Rewrite the last paragraph for clarity

4. Develop your first Web3 App

  • - Replace TS with plain JS

5. Multi-Signatures Transaction

  • - Fix the missing link at the bottom

6. Implement Custom Provider

  • - Fix broken links
  • - Update with the most up-to-date info, fix outdated code snippets
  • - Fix punctuation and logical flaws

7. Smart Contract Transactions

  • - Fix punctuation
  • - Make it more engaging. Currently it reads like a manual
  • - Create a full working example

8. Aiken hello world

  • - Fix punctuation
  • - Make it more engaging. Currently it reads like a manual
  • - Fix the Aiken Hello World website (currently it’s hanging after submitting the first tx)

9. Executing a standalone script

  • - Fix punctuation
  • - Replace tsx package installation and TS file with plain JS

10. Resolve Node-Specific Imports Errors

  • - Change the title to include information about it being a browser-based env

11. Mint an NFT Collection

  • No changes needed

Activity

  1. jinglescode commented on Sep 9, 2025

    @jinglescode
    Member

    @PiotrNap good feedbacks.

  2. jinglescode commented on Sep 18, 2025

    @jinglescode
    Member

    @PiotrNap

    Typescript is a bit overkill in examples where it’s not needed. Plain JS is more beginner-friendly
    and
    Develop your first Web3 App

    • Replace TS with plain JS
      and
      Replace tsx package installation and TS file with plain JS

    can have both? most people use TS today (i think?), having both by having a tab to toggle between TS and JS, might be the way to go if wanna show JS?

    Provide more general use-cases instead of a single employee/company example
    can have simple case and leading on to this story of employee/company example

    full code example

    put in here https://github.com/MeshJS/examples and link it

    replace Tra

    for all guides, need to remove the depre Transaction class with MeshTxBuilder https://meshjs.dev/apis/txbuilder/basics

    E.g. found Transaction in https://meshjs.dev/guides/minting-on-nodejs

  3. PiotrNap commented on Sep 18, 2025

    @PiotrNap
    ContributorAuthor

    Yes @jinglescode , I think it's a brilliant idea to have two tabs to show both JS and TS!

    Gotchu. I will put the examples inside our repository and link to it. And I'll make sure no outdated APIs are being used across all guides.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

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