Tiled tree codelab #77
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #77 +/- ##
=======================================
Coverage 55.99% 55.99%
=======================================
Files 8 8
Lines 759 759
=======================================
Hits 425 425
Misses 265 265
Partials 69 69 ☔ View full report in Codecov by Sentry. |
There was a problem hiding this comment.
As I'm reading this, I see a lot of overlap between this and the main docs at https://github.com/transparency-dev/serverless-log. What's the intended difference?
I see from the comment above that it's thought of as an extension to the README. Does it make sense to just extend it? The log setup is the same for all of them I think?
| Use the `generate_keys` command with `--key_name`, a name | ||
| for the signing entity. You can output the public and private keys to files using | ||
| `--out_pub` path and filename for the public key, | ||
| `--out_priv` path and filename for the private key |
There was a problem hiding this comment.
This is quite the sentence. It looks like you tried to make it bullet points from the md file. Maybe do that so that it reads cleaner in the rendered file?
Indeed, there's a lot of overlap, this PR was started with
The README in its current form explains how to use the various commands in this repo. This codelab explains what happens under the hood when commands are called, and what effects they have on data. It might be a bit heavy lifted for someone who opens this repo for the first time to dive into these details, so I didn't want to pollute the README. It reflects the journey I went through a few months ago when I looked into this format, so I thought others who are interested in details might benefit from this. |
codelab.md is an extension of README.md, exploring the successive states a tiled tree is in when it grows.