Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add tables for core libraries #95

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

thunderbiscuit
Copy link
Member

@thunderbiscuit thunderbiscuit commented Oct 21, 2024

This PR adds two tables that aim to make explicit the lead maintainer on each of the libraries the foundation is responsible for. It's pretty drafty right now; I figured this was a good place to discuss who is lead on each of the libraries.

I took inspiration from the rust-bitcoin page.

- [BDK Documentation](https://bitcoindevkit.org/) - Our open source documentation
### Our core libraries

The core libraries are developed and maintained collectively by the Bitcoin Dev Kit devs. The following table outlines those libraries as well as an official maintainer for each of them.
Copy link
Member

@notmandatory notmandatory Jan 15, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Small nit but I think we should use lead here also.

Suggested change
The core libraries are developed and maintained collectively by the Bitcoin Dev Kit devs. The following table outlines those libraries as well as an official maintainer for each of them.
The core libraries are developed and maintained collectively by the Bitcoin Dev Kit devs. The following table outlines those libraries as well as an lead maintainer for each of them.

@notmandatory notmandatory added the documentation Improvements or additions to documentation label Jan 15, 2025
@notmandatory
Copy link
Member

@thunderbiscuit thanks for updating this!

| `bdk_core` | [bdk](https://github.com/bitcoindevkit/bdk) | |
| `bdk_esplora` | [bdk](https://github.com/bitcoindevkit/bdk) | |
| `bdk_electrum` | [bdk](https://github.com/bitcoindevkit/bdk) | |
| `bdk_bitcoind_rpc` | [bdk](https://github.com/bitcoindevkit/bdk) | |
Copy link
Member

@notmandatory notmandatory Jan 15, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Even though kyoto is still technically "experimental" I'd like to list it here to give it visibility

Suggested change
| `bdk_bitcoind_rpc` | [bdk](https://github.com/bitcoindevkit/bdk) | |
| `bdk_bitcoind_rpc` | [bdk](https://github.com/bitcoindevkit/bdk) | |
| `bdk-kyoto` | [bdk-kyoto](https://github.com/bitcoindevkit/bdk-kyoto) | [rustaceanrob] |

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
Status: Needs Review
Development

Successfully merging this pull request may close these issues.

2 participants