IntersectMBO / IntersectMBO/formal-ledger-specifications

Confusing section links

Open
#756 2 comments 0 reactions 1 assignee Claimed by @williamdemeo View on GitHub
documentation
Dominant language
Agda
Stars
52
Forks
20
Avg merge
6d 14h
Merged PRs (30d)
7

Description

It was pointed out to me that the links in the introduction next to the tree of STSs are somewhat confusing, specifically these ones: https://github.com/IntersectMBO/formal-ledger-specifications/blob/master/src/Ledger/Introduction.lagda#L176

Every item links to both internal sections and the source code, which is useful, but this isn't super clear from the document itself. I think it would be better to have something such as: 'CHAIN (Section XX, source) is the top level transition ...'.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.