add readme and intro fix

[pz-max]

Closes # (if applicable).

Add figures and references to power system examples. People need to have a quick lick to Davide's zenodo repo.

Checklist

• I consent to the release of this PR's code under the AGPLv3 license and non-code contributions under CC0-1.0 and CC-BY-4.0.
• I tested my contribution locally and it seems to work fine.
• Code and workflow changes are sufficiently documented.
• Newly introduced dependencies are added to envs/environment.yaml and doc/requirements.txt.
• Changes in configuration options are added in all of config.default.yaml and config.tutorial.yaml.
• Add a test config or line additions to test/ (note tests are changing the config.tutorial.yaml)
• Changes in configuration options are also documented in doc/configtables/*.csv and line references are adjusted in doc/configuration.rst and doc/tutorial.rst.
• A note for the release notes doc/release_notes.rst is amended in the format of previous release notes, including reference to the requested PR.

[pz-max]

Docs changes:

• Readme changes are just a figure description.

[davide-f]

Thanks @pz-max !
A little comment, what do you think?

[pz-max]

Good point 👍🏽 I will use them just the links from the read e

[pz-max]

@davide-f

Thanks @pz-max ! A little comment, what do you think?

Changes accepted. Added now additionally some of the "how the docs" bits in the Contribute Section. The "how the docs" page was previously fully omitted. Feel free to merge when its fine.

FYI, also changed in the readthedocs admin options that there should be an independent docs build per PR such that we can review more easily. I guess it will be build with the next PR.

[davide-f]

Great Max :) I've fixed a refuse, merging as CI passes

[pz-max]

@davide-f, I think there is a misunderstanding. I think the Readme pictures should be in the documentation. Not everybody is reading the Readme, and some non-dev people will default to the documentation. The global modelling pictures as well as the description to more model pictures is very useful (Tom B or others never find those).

So, my suggestion with the openmod image links was intended and, in my opinion, that is not a big overhead. This PR has nothing to do with the general docs picture architecture suggestion in Discord. If you agree, can you revert your commit? Happy to discuss in the next dev meeting

[davide-f]

Agree @pz-max , apologies; I reset the previous change.
As CI passes, it gets merged :)