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 structure for miden-book #1716

Merged
merged 2 commits into from
Mar 21, 2025
Merged

Update structure for miden-book #1716

merged 2 commits into from
Mar 21, 2025

Conversation

phklive
Copy link
Contributor

@phklive phklive commented Mar 21, 2025

In this PR I propose to:

  • Update the deploy script for the mdbook
  • Update book.toml, makefile, .gitignore to support mdbook
  • Add EXPORTED.md to represent to miden-book view of the VM documentation and SUMMARY.md for the local view.

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

phklive commented Mar 21, 2025

@bobbinth considering this PR could you clarify what parts from EXPORTED.md you would remove from the miden-book view?

#1679 (comment)

@phklive
Copy link
Contributor Author

phklive commented Mar 21, 2025

I keep this PR opened until I get approval on all 4 PR's in:

This will make sure that if we find a change that needs to be added to all PR's we can make sure to not have to re-open another PR.

After merging these 4 PR's we should be done with the V1 of the miden-book

Copy link
Contributor

@bobbinth bobbinth left a comment

Choose a reason for hiding this comment

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

Looks good! Thank you!

@bobbinth bobbinth merged commit 36543de into next Mar 21, 2025
10 of 11 checks passed
@bobbinth bobbinth deleted the phklive-mdbook-support branch March 21, 2025 21:21
bobbinth pushed a commit that referenced this pull request Mar 21, 2025
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