search

alan-turing-institute / DTBase

A starting point from which digital twins can be developed.
MIT License
11 stars 4 forks source link

Rewrite the documentation #234

Closed mhauru closed 6 months ago

mhauru commented 7 months ago

I rewrote large parts of the READMEs and added much new stuff. It's not done done, this is just the first pass, but I think would be good to get comments and then get this merged, and we can keep on building on this together.

One question @EdwinB12 and I talked about that we need to decide is whether we should have multiple READMEs for the many subparts of the repo or one massive one with a lot of headings. I went with the former, but actually thought the latter might be better in the end, although Edwin then did some work trying to convince me otherwise.

codecov-commenter commented 7 months ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 90.64%. Comparing base (df5e44d) to head (51a01ef). Report is 9 commits behind head on main.

:exclamation: Current head 51a01ef differs from pull request most recent head 9e12097. Consider uploading reports for the commit 9e12097 to get more accurate results

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #234 +/- ## ========================================== + Coverage 90.63% 90.64% +0.01% ========================================== Files 79 79 Lines 5702 5699 -3 ========================================== - Hits 5168 5166 -2 + Misses 534 533 -1 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

mhauru commented 7 months ago

I've tagged everyone and their pets as reviewers, since feedback from people who do not know the codebase thoroughly might be the most valuable feedback in this case.

EdwinB12 commented 6 months ago

Oh and lets add the simple ingress example in this PR.

mhauru commented 6 months ago

@EdwinB12, I attended to all the points you raised (except for one, see above), and also did a read through of everything and made lots of small changes. Could you take another look please? I'm happy to merge once you are.