docs: add documentation in docusaurus format

[lima-limon-inc]

Closes #98

Besides adding a tutorial, this PR also includes:

• A "getting started" page, which documents how to use midenup
• A "design" page explaining some aspects of midenup's implementation

[bitwalker]

Let's remove this for now - our documentation is going to be done via Docusaurus going forward, so I don't think it makes sense to build them as mdbook docs at this point:

/cc @Keinberger

[bitwalker]

I'll let @Keinberger do a review here, and I'll defer to him on the structure/config of the docs so that it meshes with our overall documentation system and strategy.

[Keinberger]

Hey @lima-limon-inc , thanks for opening up this PR to add documentation to midenup!

We are currently in the phase of migrating all our documentation from mdbook to Docusaurus.

Henceforth we need to change this PR to be in line with that and implement a local Docusaurus environment instead of using mdbook.

Please take a look at the code of this PR and its respective files: 0xMiden/miden-base#1943

Things to take a look at:

• Everything inside of docs/ directory (for Docusaurus project structure and Docusaurus md syntax)
• .github/workflows (those have to be added for the midenup docs too)
  • trigger-deploy-docs.yml: This workflow has to be added to trigger a rebuild & redeployment of the docs whenever changes occur
  • build-docs.yml: This workflow builds the docsupon changes and serves to catch bugs, syntax and linting errors in the docs

After that, please amend this current PR so that it implements a Docusaurus docs project in line with the PR code that I just shared. That way, it can be integrated into the general structure/config of our Miden Docs.

I did not review the content of the markdown files yet, as there might be changes due to the Docusaurus migration. I will do that once the PR has been migrated to Docusaurus, let me know once it’s ready! :) Thanks!

[lima-limon-inc]

Hi @Keinberger, I have migrated the docs from mdbook to docusaurus. Besides that change, I also re-wrote some of the documentation I had written, just so that it was clear enough.

When you have the time, would you mind giving this a review? Thanks in advance!

Let me know your thoughts 😊

[Keinberger]

Was trying to make a couple of edits to the docs (formatting, styling, etc...) but I can't since I do not have permission to make commits on this repo. Would either one of you @lima-limon-inc @bitwalker mind adding me as a contributor here?

[Keinberger]

Hey @lima-limon-inc , here's my review:

• I updated the stylesheet, added a needed override for a Docusaurus theme component (for styling) and also fixed the fomratting in the md files so that the spacing is correctly reflected on the render. For me to push those changes though, please add me as a contributor to this repo.
• Content wise I think this is good to go!

Before merging, I have a couple of asks for you:

• Please align the styling of code components (adding terminal header) and code blocks (make them collapsible), with this branch here: https://github.com/0xMiden/miden-docs/blob/feat/getting-started/docs/quick-start/create-account.md
• I think the installation instructions have to be more thorough. I was working on a new parts of the docs that uses midenup a couple weeks ago. To get midenup correctly set up, there are more steps required as outlined in the README or the Installation page. Please incorporate the instructions from here in the Installation page: https://github.com/0xMiden/miden-docs/blob/623381639ab54f45ca2d2eca0e5fae5875d9eb20/docs/quick-start/index.md. Not sure if we should also amend the README here or if we should do that in a separate PR. ⇒ link to WIP quick start guide

[bitwalker]

Was trying to make a couple of edits to the docs (formatting, styling, etc...) but I can't since I do not have permission to make commits on this repo. Would either one of you @lima-limon-inc @bitwalker mind adding me as a contributor here?

Done

[lima-limon-inc]

Hey there @Keinberger. Thank you for the feedback.

I'll be addressing your comments now!

[lima-limon-inc]

Hi @Keinberger, I have updated both installation.md and tutorial.md. I made some slight changes with respect to your docs in https://github.com/0xMiden/miden-docs/blob/623381639ab54f45ca2d2eca0e5fae5875d9eb20/docs/quick-start/index.md.

Mainly, I used the "profile" config files for the shells instead of the "rc" files. If I'm not mistaken, if an export command is present on an rc file, the PATH environment variable will be re-defined every time a shell is opened.
Additionally, I removed the initialization commands from the tutorial page since now it gets auto initialized.

Let me know what you think!

[bitwalker]

@Keinberger can you let me know if this can be merged?