docs: monitoring guide

[Mirko-von-Leipzig]

Adds monitoring documentation for both operators and node developers.

⚠️ I've also removed a bunch of scripts and configuration files which I believe are unused.

---

I'm using markdown to document things. I think for developer documentation this makes a lot of sense since they're going to be working in-repo. This makes less sense for operators, but I think for now its the content that's important; we can always move it to a formal site.

I removed the existing mkdocs scripts and references - I don't believe this is used? I also removed editor config (should be covered by rustfmt unless for some reason you don't use an LSP..), and the pre-commit configuration - once again covered by lints, fmt etc.

---

Closes #680.

[bobbinth]

I'm using markdown to document things. I think for developer documentation this makes a lot of sense since they're going to be working in-repo. This makes less sense for operators, but I think for now its the content that's important; we can always move it to a formal site.

Yes, I think markdown is fine - probably for both developers and operators. We can always transform it into something else. In fact, we could do the same thing as we do in miden-vm and miden-docs - i.e., set up mdBook to render the docs as a Gighub page.

I removed the existing mkdocs scripts and references - I don't believe this is used?

Yes, I don't think we are using this any more - but @Dominik1999 and @phklive can confirm.

I also removed editor config (should be covered by rustfmt unless for some reason you don't use an LSP..), and the pre-commit configuration - once again covered by lints, fmt etc.

Good idea! I think we should do the same in other repos. @PhilippGackstatter, @igamigo - could you do this as well in miden-base and miden-client respectively?

[igamigo]

Good idea! I think we should do the same in other repos. @PhilippGackstatter, @igamigo - could you do this as well in miden-base and miden-client respectively?

There was no .editorconfig in miden-client (not 100% sure but I don't think there ever was one).

[bobbinth]

There was no .editorconfig in miden-client (not 100% sure but I don't think there ever was one).

What about the other files removed by this PR (e.g., docs_requirements.txt, serve-doc-site.sh etc.)?

[igamigo]

Yes, just pushed a PR to remove those: 0xPolygonMiden/miden-client#737

[phklive]

I removed the existing mkdocs scripts and references - I don't believe this is used?

Yes, I don't think we are using this any more - but @Dominik1999 and @phklive can confirm.

Yes we do not use mkdocs anymore

[bobbinth]

Looks good! Thank you! I left some comments inline - mostly small things.

As I mentioned in one of the previous comments, we'd probably want to set this up as mdBook as that's what we are doing in other repos - but this should go into a different PR.

Overall, I'm thinking we should work toward the following structure:

.
├── Introduction
│   ├── Overview
│   ├── Get started
│   └── FAQ
├── Operator guide
│   ├── Installation
│   ├── Configuraton
│   ├── Usage
│   ├── Monitoring
│   └── Updating
├── RPC documentation
└── Developer guide
    ├── Overview
    ├── Monitoring
    └── [more sections in the future]