DOCUMENTATION: Improve documentation and tutorials for final users

[miquelcampos]

• Document for Shifter rig features
• Video tutorial for character rigging under 15 min with voice over
• Document for all menu tools

[jdrese]

Hello Miquel.

I am creating a brand new sphinx project/configuration for mGear. While doing so I might restructure the mgear_dist repository by moving everything related to mgear's direct repos into a framework folder. This will come more easier to show than explain so i will inform you when I've pushed my changes into the documentation branch in mgear_dist

[miquelcampos]

Hi @jdrese
I am not working on the documentation right now, so I think is perfect timing to update this.

However, about changing the folder structure, can we talk before? I know you are going to test it before push the change. but I wonder if is worth to create another repo for the new structure. After all the idea of splitting everything on repos was that. To allow different distributions and structures. So let talk :)

[jdrese]

Hi @miquelcampos .

I might need to explain a little bit further. My idea isn't to change how we setup the repositories as I think this is okay now, what I want is the submodules inside mgear_dist to be a little bit more structured.

We would have something like the following (for example)

• mgear_dist
  • framework
    • shifter
    • flex
    • cranck
    • ....
• excons
• doc
• ...

The idea is just to clean up a little bit by categorizing a tiny bit (i know this isn't great when it comes to code). This isn't really a most have. I am just trying to see if we can have a structure that helps faster to understand what is what and what really is part of the framework and what is actually part of the distribution.

Does this give you more information about it?

[miquelcampos]

add Chris mGear guide to the official docs
https://rigmarolestudio.com/mgear-rigging-workflow/

[miquelcampos]

update rigging workflow snippets

# THIS WILL FAIL
from mgear import rigbits
a = rigbits.facial_rigger.eye_rigger.rig_from_file

# THIS WORKS
from mgear.rigbits.facial_rigger import eye_rigger
a = eye_rigger.rig_from_file