Skip to content

Write a usage guide using mdBook #1

@udoprog

Description

@udoprog

mdBook is a nice way to write documentation that is also readable as markdown.

A lot of Rust projects are using it.

  • Set up basic book.
  • Document the basics of how the tests run directly on the parity virtual machine and what that means (fast tests, lots of introspection).
  • How to call a function on a contract.
  • How to call a fallback function.
  • How and why to use a linker.
  • How to test that events are emitted.
  • How to debug a revert.
  • How to do unit testing.
  • How to do property testing.

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions