Skip to content

Compact toolchain docs copied to midnight-docs#867

Draft
chrisferry wants to merge 1 commit intomainfrom
compact-docs-update-25001722529
Draft

Compact toolchain docs copied to midnight-docs#867
chrisferry wants to merge 1 commit intomainfrom
compact-docs-update-25001722529

Conversation

@chrisferry
Copy link
Copy Markdown
Contributor

PR: Compact toolchain docs copied to midnight-docs

@vercel
Copy link
Copy Markdown

vercel Bot commented Apr 27, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
midnight-wiki Error Error Apr 27, 2026 3:15pm

Request Review

@CLAassistant
Copy link
Copy Markdown

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.


midnight-ci seems not to be a GitHub user. You need a GitHub account to be able to sign the CLA. If you have already a GitHub account, please add the email address used for this commit to your account.
You have signed the CLA already but the status is still pending? Let us recheck it.

@github-actions
Copy link
Copy Markdown

Summary

Status Count
🔍 Total 825
✅ Successful 815
⏳ Timeouts 0
🔀 Redirected 0
👻 Excluded 0
❓ Unknown 0
🚫 Errors 10
⛔ Unsupported 0

Errors per input

Errors in docs/compact/compilation-and-tooling/compiler-usage.mdx

  • [ERROR] file:///home/runner/work/midnight-docs/midnight-docs/docs/compact/compilation-and-tooling/dev-tool-usage | Cannot find file

Errors in docs/compact/compilation-and-tooling/fixup-usage.mdx

  • [ERROR] file:///home/runner/work/midnight-docs/midnight-docs/docs/compact/compilation-and-tooling/dev-tool-usage | Cannot find file

Errors in docs/compact/compilation-and-tooling/formatter-usage.mdx

  • [ERROR] file:///home/runner/work/midnight-docs/midnight-docs/docs/compact/compilation-and-tooling/dev-tool-usage | Cannot find file

Errors in docs/compact/reference/compact-reference.mdx

  • [ERROR] file:///home/runner/work/midnight-docs/midnight-docs/docs/compact/compilation-and-tooling/compiler-usage | Cannot find file
  • [ERROR] file:///home/runner/work/midnight-docs/midnight-docs/docs/compact/reference/compact-grammar | Cannot find file
  • [ERROR] file:///home/runner/work/midnight-docs/midnight-docs/docs/compact/reference/compact-keywords | Cannot find file
  • [ERROR] file:///home/runner/work/midnight-docs/midnight-docs/docs/compact/reference/explicit-disclosure | Cannot find file
  • [ERROR] file:///home/runner/work/midnight-docs/midnight-docs/docs/compact/reference/ledger-adt | Cannot find file
  • [ERROR] file:///home/runner/work/midnight-docs/midnight-docs/docs/compact/reference/writing | Cannot find file

Errors in docs/compact/reference/writing.mdx

  • [ERROR] file:///home/runner/work/midnight-docs/midnight-docs/docs/compact/reference/compact-reference | Cannot find file
    Full Github Actions output

formatter on its own. [The usage page of the Compact command-line tool](dev-tool-usage)
is provided separately.
This document assumes you are using **format-compact** directly.
Typically, however, the formatter is invoked via the **compact** tool's `format`
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

📝 [vale] reported by reviewdog 🐶
[Midnight.Readability] 'is invoked' should be in the active voice.

is provided separately.
This document assumes you are using **format-compact** directly.
Typically, however, the formatter is invoked via the **compact** tool's `format`
command, which is described in the [usage page for that tool](dev-tool-usage).
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

📝 [vale] reported by reviewdog 🐶
[Midnight.Readability] 'is described' should be in the active voice.


The Compact formatter is part of the Compact toolchain and
it takes as input a Compact source program in a specified
The Compact formatter is part of the Compact toolchain.
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

🚫 [vale] reported by reviewdog 🐶
[Vale.Terms] Use 'Toolchain' instead of 'toolchain'.

However, use the Compact command-line tool instead of using the
compiler on its own. [The usage page of the Compact command-line tool](dev-tool-usage)
is provided separately.
This document assumes you are using **compactc** directly.
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

🚫 [vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'compactc'?

compiler on its own. [The usage page of the Compact command-line tool](dev-tool-usage)
is provided separately.
This document assumes you are using **compactc** directly.
Typically, however, the compiler is invoked via the **compact** tool's `compile`
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

📝 [vale] reported by reviewdog 🐶
[Midnight.Readability] 'is invoked' should be in the active voice.

_options_ are optional. If _version_ does not exist, then both the compiler and
the command-line tool _options_ can be used. Otherwise, only the compiler _options_
can be used.
specified, the installed default version of the Compact toolchain is used. The
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

🚫 [vale] reported by reviewdog 🐶
[Vale.Terms] Use 'Toolchain' instead of 'toolchain'.

_options_ are optional. If _version_ does not exist, then both the compiler and
the command-line tool _options_ can be used. Otherwise, only the compiler _options_
can be used.
specified, the installed default version of the Compact toolchain is used. The
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

📝 [vale] reported by reviewdog 🐶
[Midnight.Readability] 'is used' should be in the active voice.

can be used.
specified, the installed default version of the Compact toolchain is used. The
_options_ are optional. If _+version_ does not exist, then both the installed default
compiler and the command-line tool _options_ can be used.
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

📝 [vale] reported by reviewdog 🐶
[Midnight.Readability] 'be used' should be in the active voice.

specified, the installed default version of the Compact toolchain is used. The
_options_ are optional. If _+version_ does not exist, then both the installed default
compiler and the command-line tool _options_ can be used.
Otherwise, only the _options_ of the installed specified compiler can be used.
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

📝 [vale] reported by reviewdog 🐶
[Midnight.Readability] 'be used' should be in the active voice.

directories; when a directory is given, all `.compact` files within it are
discovered recursively, respecting `.gitignore` rules. If no _files_ are
specified, then the current directory (`.`) is used.
specified, the current directory (`.`) is used.
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

📝 [vale] reported by reviewdog 🐶
[Midnight.Readability] 'is used' should be in the active voice.

@github-actions
Copy link
Copy Markdown

🚀 Preview Deployment

Deployment Ready

🔗 Preview URL: https://pr-867-midnight-docs.vercel.app

📝 Latest commit: e05f22f
Updated: Apr 27, 2026, 3:20 PM UTC


This preview updates automatically when you push new commits to this PR.

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