Add a bunch of project management docs#4844
Conversation
|
Concept ACK doing this. So far 7e2efc5 looks great. Clearly WIP but some of this stuff we'll need to get our hands dirty before we can figure out the exact crate relationships. |
We have a pluralisation anomoly - modules use singular (`address`, `key`) - crates use plural (`addresses`, and maybe `keys`) Lets use the crate name for the docs file since the document describes the crate.
Recently I hypothesised that `rust-bitcoin` needed a project manager - well here I am stepping up to the plate. Created by going through rust-bitcoin#550, wip because I'm up to rust-bitcoin#550 (comment) Please review at any level, I'm open to doing anything differently as suggested.
7e2efc5 to
9d11812
Compare
|
This looks great. I will give it a shot using a LLM to review my code to check whether it's consistent with the policy docs, because some stuff (e.g. the doc inlining) is a subtle syntactical thing that has no locally-visible effect. Your summaries of the crypto/taproot/keys situation looks good. Probably we will do substantial revision to them when we start working on them. But the point of the doc is that new people who see this mess and want to try to clean it up will have a starting place. And not need to dig through 10 years of old issues and PRs to try to infer what our goals are. |
Add a bunch of docs while reading over #550.
FTR after discussion offline between Andrew and myself we are attempting to create a
docs/directory that holds specifications on current and future work as well as API nuances etc. Devs can then read the 'specs' when coding instead of trawling through enormous issues discussions. Furthermore any issue that gets unwieldy will be moved to a GitHub discussions because they have threading.We took inspiration from: https://github.com/jj-vcs/jj/tree/main/docs
Close #550