formal-ledger-specifications icon indicating copy to clipboard operation
formal-ledger-specifications copied to clipboard

Confusing section links

Open WhatisRT opened this issue 9 months ago • 2 comments

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 ...'.

WhatisRT avatar Apr 14 '25 14:04 WhatisRT

After thinking more about this, I think it's perfectly clear. The first link goes to the source and a popup clearly indicates that is the case. The second link is clearly labeled as pointing to a section. I don't think this needs to be changed.

williamdemeo avatar Apr 25 '25 04:04 williamdemeo

Maybe you don't, but someone was complaining to me about this at the node diversity meetup (I don't quite remember who), so it deserves to be treated as a user issue.

WhatisRT avatar Apr 28 '25 10:04 WhatisRT