WIP language reference and supporting materials for Compact 1.0

[dybvig]

No description provided.

[vercel]

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

Project	Deployment	Actions	Updated (UTC)
midnight-wiki	Ready	Preview, Comment	Mar 25, 2026 5:22pm

[github-actions]

🚀 Preview Deployment

✅ Deployment Ready

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

📝 Latest commit: 80985dc
⏰ Updated: Mar 25, 2026, 5:20 PM UTC

---

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

[CLAassistant]

All committers have signed the CLA.

[pataei]

Looks good to me. Just a few minor suggestions.

Also, when previewing the doc, I noticed in the compact-reference.mdx doc that code blocks were missing padding and looked a bit weird. Is this intended? Otherwise, we might need to investigate it.

Here is a preview of what I'm referring to...

Thanks @gyrationtechs for a quick turnaround. I'm double checking with @dybvig on the formatting of code snippets.

[pataei]

@gyrationtechs two follow up question:

• should we keep https://github.com/midnightntwrk/midnight-docs/blob/main/main_versioned_docs/version-0.0.0/develop/reference/compact/lang-ref.mdx up-to-date too? We've just updated https://github.com/midnightntwrk/midnight-docs/blob/main/docs/compact/reference/lang-ref.mdx.
• is there a way to have Compact on top of the page right before or after API reference as well as having it on the sidebar and have them point to the same files? (I'm attaching a screenshot to show what I mean, in the screenshot I want Compact to be on top--I used an arrow to bring attention to it-- and I want it to have the same structure as the sidebar Compact--I wrapped around it with a red rectangle. I don't know if it's possible to have both the top and the sidebar Compact and have them use the same files and not duplicate the files for each othem.)

[dybvig]

The code blocks look good to me without padding, but if you prefer padding, we could go with something small like "padding: 4px". The default is too large for my taste and also sometimes provides less than adequate horizontal space for the code given that the size of the center window is limited.

[pataei]

The code blocks look good to me without padding, but if you prefer padding, we could go with something small like "padding: 4px". The default is too large for my taste and also sometimes provides less than adequate horizontal space for the code given that the size of the center window is limited.

@dybvig I applied this and propagated it back to lfdt/compact repo in the PR I have for TS target.

[gyrationtechs]

@pataei

1. The versioned (0.0.0) docs are deprecated and shouldn't be updated. We left them as historical data and are not actively updating any docs from the directory.
2. Yes, we can do that. Just to clarify. Do you mean having a link in the top navbar that points to the /compact category? Or are you referring to having the link along with dropdown options to other Compact docs?

[dybvig]

Actually, the problem is that the padding is included not only for the code blocks but also for code segments in the text, and that looks funny with anything even as high as 4px. 2px looks pretty good, so I've switched to that. I also set up explicit-disclosure.mdx and writing.mdx to use the lang-ref style.

[pataei]

@pataei

2. Yes, we can do that. Just to clarify. Do you mean having a link in the top navbar that points to the /compact category? Or are you referring to having the link along with dropdown options to other Compact docs?

@gyrationtechs The former, I want Compact to appear at the top and to be linked to the same files that are used for the sidebar (still I want to keep Compact in the sidebar as well).

Also if you're happy with this PR can we get an approval and merge it and then do the change for having Compact on top of the page as well?

[gyrationtechs]

@pataei I will make the site navigation changes in a separate PR.