docu for users and devs extended

[ckolbPTB]

Closes #106

[github-actions]

Coverage Report

File	Stmts	Miss	Cover	Missing
src/mrpro/algorithms
_remove_readout_os.py	30	2	93%	47, 49
src/mrpro/data
_AccelerationFactor.py	13	13	0%	15–36
_AcqInfo.py	64	1	98%	93
_DcfData.py	78	3	96%	71, 97, 178
_KData.py	86	6	93%	82–83, 125, 152, 157–158
_KHeader.py	125	9	93%	34, 81, 119, 170, 181, 188–189, 192, 199
_KNoise.py	21	9	57%	48–61
_SpatialDimension.py	39	5	87%	74, 77, 84–86
_TrajectoryDescription.py	14	1	93%	35
src/mrpro/data/traj_calculators
_KTrajectoryCalculator.py	16	1	94%	37
_KTrajectoryIsmrmrd.py	16	2	88%	55, 65
_KTrajectoryPulseq.py	36	1	97%	69
_KTrajectoryRadial2D.py	26	2	92%	49, 53
_KTrajectoryRpe.py	43	2	95%	110, 112
src/mrpro/utils
_rgetattr.py	3	1	67%	20
TOTAL	1104	58	95%

Tests	Skipped	Failures	Errors	Time
63	0 💤	0 ❌	0 🔥	17.139s ⏱️

[ckolbPTB]

@schote I know this is very basic but can you think of anything which is missing but absolutely necessary (or easy to add)? If you have an example of a good documentation of another repo, this would also be very helpful.

[schote]

@schote I know this is very basic but can you think of anything which is missing but absolutely necessary (or easy to add)? If you have an example of a good documentation of another repo, this would also be very helpful.

In my opinion scikit-learn has a good documentation, which we could use as a reference. I think as soon as we have our first release and a release strategy (in case this is planned at some point) we should add:

• versioning to indicate the version the documentation refers to
• changelog
• timeline to indicate what future implementations are planned (could be helpful if one needs to make a decision whether or not the package is suitable or will be suitable)

Besides that I would add some minimal examples. I think you also already have that in mind with the notebooks, right @ckolbPTB ?

[ckolbPTB]

scikit-learn has a very nice documentation - might be a bit too ambitious for us but let's see.

Yes, the examples will be done via automatically creating jupyter notebooks PR #118

I added an issue regarding the versionen and release strategy #125

@schote Could you do a quick review of these changes such that I can merge them before the hackathon next week? thanks!

[schote]

I think the documentation helps a lot to better understand the structure of the repository 👍🏼