Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update docs to support mdbook #1190

Draft
wants to merge 15 commits into
base: main
Choose a base branch
from
Draft

Update docs to support mdbook #1190

wants to merge 15 commits into from

Conversation

phklive
Copy link
Contributor

@phklive phklive commented Feb 28, 2025

To have a miden book we will need to import docs from all repositories, for that to work we need to programmatically build the summary.md of the Miden book, hence we need each repo to be structured as an mdbook to do so first.

This PR turns the miden-base docs into an mdbook

@phklive phklive added the no changelog This PR does not require an entry in the `CHANGELOG.md` file label Feb 28, 2025
Copy link
Contributor

Choose a reason for hiding this comment

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

Where does this info go now?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

It has been moved into each individual section.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Also wanted to know if all the information in Batch and Block is accurate?

Copy link
Contributor

Choose a reason for hiding this comment

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

@bobbinth
Copy link
Contributor

bobbinth commented Mar 5, 2025

@phklive - is this good to review? (asking because it is still in draft mode)

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