Add Dev Workflow Docs

[willtebbutt]

Addresses #268 . @sunxd3 would you mind taking a quick look at this and letting me know if it is clear? I feel like you have most experience developing Mooncake after me, so you are likely best positioned to judge this.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

[github-actions]

Performance Ratio:
Ratio of time to compute gradient and time to compute function.
Warning: results are very approximate! See here for more context.

┌────────────────────────────┬──────────┬──────────┬─────────────┬─────────┐
│                      Label │ Mooncake │   Zygote │ ReverseDiff │  Enzyme │
│                     String │   String │   String │      String │  String │
├────────────────────────────┼──────────┼──────────┼─────────────┼─────────┤
│                   sum_1000 │     70.8 │      1.0 │        5.61 │ missing │
│                  _sum_1000 │     7.15 │ 347000.0 │        33.2 │ missing │
│               sum_sin_1000 │     2.27 │     1.72 │        10.6 │ missing │
│              _sum_sin_1000 │     2.64 │    243.0 │        13.1 │ missing │
│                   kron_sum │     60.1 │     3.93 │       201.0 │ missing │
│              kron_view_sum │     62.2 │     9.75 │       256.0 │ missing │
│      naive_map_sin_cos_exp │     2.53 │  missing │        7.12 │ missing │
│            map_sin_cos_exp │     2.72 │     1.43 │         6.0 │ missing │
│      broadcast_sin_cos_exp │     2.61 │     2.27 │        1.46 │ missing │
│                 simple_mlp │     2.98 │      1.3 │        8.17 │ missing │
│                     gp_lml │     5.73 │     1.58 │     missing │ missing │
│ turing_broadcast_benchmark │     3.83 │  missing │        24.3 │ missing │
│         large_single_block │     4.03 │   4240.0 │        30.1 │ missing │
└────────────────────────────┴──────────┴──────────┴─────────────┴─────────┘

[sunxd3]

not a suggestion, just a anecdotal point from me: I configure VSCode to automatically do the Pkg.activate() for the package folder I open. But what you wrote is better as it assumes less.

[willtebbutt]

Thanks for letting me know -- this is good to know.

[sunxd3]

All make sense, thanks Will. I use VSCode REPL integration quite often, particularly ctrl/shift+enter to execute code.

[willtebbutt]

Thanks for the review @sunxd3 -- I'll merge when CI passes.