Docs

[cc-a]

Description

This PR adds developer documentation for the project. As I'm looking to step back from leading the project this is a great time to ask any questions you may have about Dune or the development setup or just about anything so we can record it now.

Fixes: #210 #211 #212 #173

Type of change

• Documentation (non-breaking change that adds or improves the documentation)
• New feature (non-breaking change which adds functionality)
• Optimization (non-breaking, back-end change that speeds up the code)
• Bug fix (non-breaking change which fixes an issue)
• Breaking change (whatever its nature)

Key checklist

• All tests pass (eg. python -m pytest)
• The documentation builds and looks OK (eg. python -m sphinx -b html docs docs/build)
• Pre-commit hooks run successfully (eg. pre-commit run --all-files)

Further checks

• Code is commented, particularly in hard-to-understand areas
• Tests added or an issue has been opened to tackle that in the future. (Indicate issue here: # (issue))

[codecov-commenter]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 82.84%. Comparing base (41de11f) to head (db3b973).

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #246      +/-   ##
==========================================
- Coverage   83.33%   82.84%   -0.50%     
==========================================
  Files          34       33       -1     
  Lines         432      408      -24     
==========================================
- Hits          360      338      -22     
+ Misses         72       70       -2     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[dalonsoa]

I've made a couple of comments, but looks great to me.

Certainly part of a different PRs, but I think it would be valuable at some point to describe in detail the Dockerfiles and the docker-compose file. Much (all?) of what this tool does - at least in development - depends on the docker setup, so a good understanding on what's going on there would be useful.

[cc-a]

Sounds good @dalonsoa. I've made #251 to track.

[dalonsoa]

LGTM!

[AdrianDAlessandro]

This looks good to me. I'm not sure what's missing, but what is there works. I've made a comment about removing detail from the readme. Hopefully my suggestion can help get the setup instructions back into there.

[jamesturner246]

Besides the Mac note @AdrianDAlessandro mentioned, LGTM. 👍

I can't think of anything else required to get going offhand. My only questions really were about when and where we should be accessing drunc directly for debugging, but that will be covered in #249, I guess.