Skip to content

Conversation

@sellout
Copy link
Contributor

@sellout sellout commented Sep 27, 2025

Overview

transcripts had run against all Markdown files in the repo to do a basic sanity check on anything that might contain transcript stanzas. However, for docs, it’s useful to make quick edits directly on GitHub, which meant the golden files wouldn’t get updated, and the transcript tests would fail after the change.

This removes transcripts checking on the docs folder to allow GitHub edits of those files.

Test coverage

This ostensibly removes test coverage of some Markdown files, but there are few stanzas that would be picked up as transcripts, and they’re only used for syntax highlighting.

If demonstrations of transcripts were added to docs, they would likely be nested within markdown blocks, like

```` markdown
This is an example of a transcript. It can contain text like this, and executable code blocks like

``` unison
foo = bar
```
````

which wouldn’t be picked up by the transcript tests anyway.

`transcripts` had run against all Markdown files in the repo to do a
basic sanity check on anything that might contain transcript stanzas.
However, for docs, it’s useful to make quick edits directly on GitHub,
which meant the golden files wouldn’t get updated, and the transcript
tests would fail after the change.

This removes `transcripts` checking on the `docs` folder to allow GitHub
edits of those files.
@sellout sellout requested a review from aryairani September 27, 2025 15:03
type Tree = Branch Tree Tree | INode (Optional ##Int) | BNode Boolean
```
This gives us a decl with two constructor types:
This gives us a decl with three constructor types:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

😉

@aryairani aryairani merged commit edb69ff into unisonweb:trunk Sep 27, 2025
18 checks passed
@sellout sellout deleted the doc-transcripts branch October 8, 2025 16:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants