Docs improvements wish-list

A meta ticket describing some features or changes that improve the readability of the docs, or improve the docs writing workflow. Please add if you notice something that might be helpful!

[x] Block evaluation and @typecheck blocks in docs should preserve type signatures above term definitions
[ ] Should we provide a different way to render when a snippet raises an error? Currently, if you're trying to document error states, you might try to evaluate something which causes a particular error in which case you'll get a general "sos" message.
[ ] Should we provide a different way to render when a snippet fails to typecheck? If you're trying to teach "this is broken and here's why" content, a broken codeblock will (correctly according to the rules of the eval block) fail to typecheck and cannot be added. You can use the raw keyword but that might have ramifications for the view layer. (EDIT: this is probably not useful for more than language documentation because most people will have better error handling)
[X] Not sure if this is possible, or desirable for this element but could the @foldedSource doc element support inline doc content (as opposed to referencing only external terms or types for viewing and hiding)? (EDIT: this is supported with Folded)
[ ] NamedLink could use an additional Text field to represent a title on html anchor tags which is good for screenreaders.
[ ] Support embedding video and audio
[ ] A resource section - collection of links.
[ ] Configurable bullets; like emojis in bullet list — perhaps this means optional bullets such that the author can add their own
[x] Should FoldedSource have a Bool like Folded does? Alternative could FoldedSource just be removed such that we just have Folded?
[ ] Block evaluation should support type definitions. Currently it doesn't look like we can do type myType = blah inside triple backticks.
[ ] Need a way to embed type expressions and have them kind checked + hyperlinked
[ ] It would be great to have live UCM output so that Unison + UCM interactions can be scripted and better documented without drift.

unisonweb / unison

Docs improvements wish-list #2111