Skip to content

[#180] Add contract documentation tutorial to Indigo website

Moremi Vannak requested to merge rinn7e/#180-doc-tutorial-indigo into master

Description

Problem: The first problem is that documenting entrypoints requires defining instances of a big typeclass, which is scary-looking for beginners, especially if they are not Haskell-friendly.

The second problem is that, while there are ways to print and create contracts from ghci explained in the tutorial, there is no explanation of docs in it or method to interact with them.

Solution: Add documentation tutorial including the interacting docs via the REPL.

Related issue(s)

Resolves #180 (closed)

Checklist for your Merge Request

Related changes (conditional)

  • Tests (see short guidelines)

    • If I added new functionality, I added tests covering it.
    • If I fixed a bug, I added a regression test to prevent the bug from silently reappearing again.
  • Documentation

    • I checked whether I should update the docs and did so if necessary:
    • I updated changelog files of all affected packages released to Hackage if my changes are externally visible.

Stylistic guide (mandatory)

Edited by Moremi Vannak

Merge request reports