Skip to content

docs: update public guides#2185

Open
Mirko-von-Leipzig wants to merge 11 commits into
nextfrom
mirko/guides
Open

docs: update public guides#2185
Mirko-von-Leipzig wants to merge 11 commits into
nextfrom
mirko/guides

Conversation

@Mirko-von-Leipzig
Copy link
Copy Markdown
Collaborator

@Mirko-von-Leipzig Mirko-von-Leipzig commented Jun 2, 2026

This PR revamps the external/public facing docs to the new distributes sequencer/full node configuration.

I have also:

  • Applied formatting and lints in CI.
  • Moved the above to ci.
  • Changed the doc deployment workflow to only concern itself with that.
  • Renamed a bunch of the make compose-x to make local-network-x

I still need to do the network operator guide. It does contain content, but that was AI generated and has not had a pass (or three) done on it. Please ignore that section.

I would suggest reviewing using the actual docusaurus server, and not as raw markdown nor the diffs since this is effectively a full rewrite. Also note that the guides use a binary/docker tab split.

make install-tools
cd docs/external                                                                                                                                      
npm ci
npm run start:dev

I'll keep pushing changes until the operator guide is complete as well; but this is a large chunk so having reviews come in would be great.

@Mirko-von-Leipzig Mirko-von-Leipzig added the no changelog This PR does not require an entry in the `CHANGELOG.md` file label Jun 2, 2026
@Mirko-von-Leipzig
Copy link
Copy Markdown
Collaborator Author

cc @igamigo who might be interested in the local network setup.


# Migrations

Occasaionally, a new node version requires storage schema changes. These can be applied using the `mgirate` command
Copy link
Copy Markdown
Collaborator

@sergerad sergerad Jun 2, 2026

Choose a reason for hiding this comment

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

Suggested change
Occasaionally, a new node version requires storage schema changes. These can be applied using the `mgirate` command
Occasionally, a new node version requires storage schema changes. These can be applied using the `migrate` command

Please report any issues, ask questions or leave feedback in the
[Miden node repository](https://github.com/0xMiden/node/issues/new/choose).

This includes outdated, misleading, incorrect or just plain confusing information :)
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.

nit: This sentence is unnecessary

Copy link
Copy Markdown
Collaborator

@sergerad sergerad left a comment

Choose a reason for hiding this comment

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

Just typo / nit

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

no changelog This PR does not require an entry in the `CHANGELOG.md` file

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants