Welcome to the Micetro Documentation!

[dinchamion]

Welcome to the Micetro Documentation! We're thrilled to have you here.

TL:DR: this repository is for you. We'd ❤️ your input. Nay: we want it.

--

Story time. 😎

Software documentation is a living organism. 🦠 (No, not like 🦠.)

We've opened up the documentation for Micetro by Men&Mice to be helpful to you, the user of Micetro. It should answer your questions and provide context around the features and functionality that will, in turn, help you make network management sustainable. (And, hopefully, a little more fun.)

Our objective is to be open and transparent. Both through contribution (pull requests) and feedback (see discussions and issues). Conversations must flow. (Like the Spice. That, too, must flow. Except our sustenance isn't the digestive byproduct of giant worms wobbling about underground. That'd be... weird. 🐛)

This post is an outline of how we envision maintaining the documentation. But it should be noted that this community (and thus its rules) is a perpetual work-in-progress, just like its organizing focal point. Another living organism. Still nothing to do with worms. It's all themed, you see?

Improving the documentation: pull requests and discussions

The first order of business we want to address is improving the content. 🧑🏻‍💻

Micetro does a lot of things. Many of those for quite a while. Just like Micetro, the documentation itself has been layered and extended throughout the years. (Decades, even. 📜) We want to make sure that nothing outdated remains hidden and nothing missing remains wanted. Or not for long, at the least.

We welcome your pull requests to fix or extend content. Or, if you're not entirely confident just yet, use discussions to point us toward what you'd like to see changed.

At the end of the day, the documentation is not written for us. It's written for you. Only you can prevent forest fires... and also know what you're looking for.

Found a problem? Let us know: issues

We all make mitsakes. 🙈

We want to use issues to triage content issues (whether it's a typo or just a mistake in explaining how things work) and minimize the exposure of bad information.

As a general rule of thumb, we really don't care whether you open an issue or a discussion as long as you open something. A window, if nothing else; fresh air is important.

There are no dumb questions: using the Q&A

In the coming weeks, we'll populate the Q&A with some frequently asked questions. Both about the documentation (such as "Which branch should I be looking at?" or "What markup language do you use?") and, to a lesser extent, about Micetro itself. We believe good information cannot be disseminated enough.

We'll see how this particular function will change over time. As always, its function (and indeed entire reason for being) is to help you.

Have at it!

The documentation is open for versions 9.3, 10.0, and 10.1 of Micetro. Enjoy! 🎉