Skip to content

Restructure Mesa docs & remove duplicates#1211

Open
glyh wants to merge 11 commits into
mainfrom
lyh/cleanup-mesa-hf-docs
Open

Restructure Mesa docs & remove duplicates#1211
glyh wants to merge 11 commits into
mainfrom
lyh/cleanup-mesa-hf-docs

Conversation

@glyh

@glyh glyh commented Jul 1, 2026

Copy link
Copy Markdown
Member

Summary

Restructures the Mesa network upgrade documentation to eliminate duplication, improve information architecture, and fix flow issues. 711 insertions, 777 deletions across 16 files. No information was lost; all removed content is preserved via cross-links to canonical sources.


Structural changes

1. Split overloaded pages

  • preflight-network.mdx (was 305 lines) → split into:
    • preflight-network.mdx (lean) — version matrix, Docker images, Debian packages, nightly builds (reference)
    • preflight-setup.mdx (new) — operator tutorials: Docker/Debian daemon setup, archive node, Rosetta, verification, support (how-to)

2. Merge sparse / redundant pages

  • fork-schedule.mdx → merged into upgrade-steps/upgrade.mdx. The fork schedule is only relevant during the Upgrade phase, so it lives there now. File deleted.
  • MIP6–MIP9 detail moved from index.mdxglossary.mdx. Index now lists one-liner summaries linking to glossary entries.
  • Pre-upgrade per-actor checklist moved from index.mdxrequirements.mdx. Requirements page now serves double duty: hardware specs + pre-upgrade procedures.

3. Slim the overview page

  • index.mdx phase tables reduced from full per-actor procedures (50+ lines each) to one-liner summaries linking to upgrade-steps/ pages.
  • Redundant ## Examples section removed (was already linked from the phase flow).

Deduplication

Eliminated triplicated callout

The "Mesa preflight hard fork completed" info box was copy-pasted verbatim in 3 files. Now lives only in preflight-network.mdx; the other two link to it.

Removed duplicate flag configuration

The 120-line collapsible flag reference in post-upgrade.mdx was removed (initially), then restored with improvements after discovering 8 flags (RAYON_NUM_THREADS, --shutdown-on-disconnect, etc.) were undocumented elsewhere. Now includes explicit links to canonical sources in node-operators/ docs.

Cross-linked repeated explanations

Duplication Fix
Dispatcher limitation explained in 3 places Examples now links to Troubleshooting
"Must use Manual mode" repeated in 3 places Index and upgrade-steps/index link to upgrade-modes
Exchange danger-box verbatim in 2 places Examples links to state-finalization
"Backward-compatible" phrase in 4 places Requirements, state-finalization, upgrade.mdx link to archive-upgrade
SNARK worker/coordinator flags (mesa ↔ external) Flag reference links to snark-workers/getting-started
Rosetta curl commands (mesa ↔ external) Post-upgrade Rosetta tab links to data-and-history/rosetta

Improved content

  • archive-upgrade.mdx: Version info uses <Tabs> (Preflight/Devnet/Mainnet) instead of a monolithic info box. Network-agnostic phrasing fixed ("Mainnet database" → "archive database with Berkeley-era data").
  • requirements.mdx: Full per-actor pre-upgrade checklist added (Block Producers, SNARK Coordinators, Archive Nodes, Exchanges, zkApp Developers).
  • upgrade.mdx: Fork schedule merged in; timestamp/slot conflation fixed.
  • post-upgrade.mdx: Duplicate ## Report Issues heading removed. Flag reference restored with improved intro and canonical links.

Configuration changes

  • sidebars.js: Removed fork-schedule entry, added preflight-setup entry.
  • docusaurus.config.js: Added redirects for /mesa-upgrade/fork-schedule and /network-upgrades/mesa/fork-schedule/network-upgrades/mesa/upgrade-steps/upgrade.

Verification

  • No broken internal links
  • All 4 TODOs preserved
  • All procedural content traceable via links (index → upgrade-steps → examples)
  • No information lost — all removed content exists at canonical sources

@vercel

vercel Bot commented Jul 1, 2026

Copy link
Copy Markdown

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

Project Deployment Actions Updated (UTC)
docs2 Ready Ready Preview, Comment Jul 1, 2026 12:52pm

Request Review

@glyh glyh marked this pull request as draft July 1, 2026 12:17
@glyh glyh force-pushed the lyh/cleanup-mesa-hf-docs branch from e7087bc to 1a5b29a Compare July 1, 2026 12:24
@glyh glyh force-pushed the lyh/cleanup-mesa-hf-docs branch from 1a5b29a to 77528a0 Compare July 1, 2026 12:26
@glyh glyh changed the base branch from main to lyh/fix-protokit-docs-compilation July 1, 2026 12:27
@glyh glyh force-pushed the lyh/cleanup-mesa-hf-docs branch from 77528a0 to c434bbd Compare July 1, 2026 12:51
@glyh glyh marked this pull request as ready for review July 1, 2026 12:55
@glyh glyh requested a review from yamimaio July 1, 2026 12:55
Base automatically changed from lyh/fix-protokit-docs-compilation to main July 6, 2026 08:33

@yamimaio yamimaio left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Hey @glyh !
I'm overall ok with this and like the changes, but there is one change in particular I don't agree with.
Please see the comments

sidebar_label: Upgrade
hide_title: true
description: Upgrade phase of the Mesa hard fork — network halt, state export, and Mesa build publication.
description: Upgrade phase of the Mesa hard fork — network halt, state export, Mesa build publication, and fork schedule values per network.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

I don't agree with this overall move of the schedule to the "upgrade" step of the Upgrade Steps, because this step is clearly about what happens after stop_network_slot.

So introducing the section where we explain what stop transaction and what stop network slots are, seems to late at this point in time.

I think Fork Schedule was ok where it was before the upgrade step


### Mainnet

:::warning Values not yet published

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

this icon is not rendering correctly in the current published version of the docs

### Faster Blocks
### Faster Blocks — [MIP6](https://github.com/MinaProtocol/MIPs/blob/main/MIPS/mip-0006-slot-reduction-90s.md)

Mesa reduces the slot time to 90 seconds and unsets the default zkApp soft limit (previously 24 commands per block). Defined in [MIP6](https://github.com/MinaProtocol/MIPs/blob/main/MIPS/mip-0006-slot-reduction-90s.md).

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

We may need to add that we lowered zkApp soft limit from 24 to 12.


| Actor | What to do |
|---|---|
| **Block Producers** | Verify your node is on the Mesa chain (`mina client status`). If automode, check that the `activated` file exists in your config directory (see [Troubleshooting](/network-upgrades/mesa/troubleshooting#how-do-i-know-which-binary-my-node-is-using)). Monitor block production. |

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Where did this table land?

Comment thread docusaurus.config.js
to: '/network-upgrades/mesa/archive-upgrade',
},
{
from: '/mesa-upgrade/fork-schedule',

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

I would not make this change

Comment thread docusaurus.config.js
to: '/network-upgrades/mesa/appendix/archive-node-schema-changes',
},
{
from: '/network-upgrades/mesa/fork-schedule',

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

same

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