Skip to content

Document structure improvement #83

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.

Sign up for GitHub

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

Jump to bottom
Closed
rajarshimaitra opened this issue Jan 2, 2022 · 4 comments
Closed

Document structure improvement #83

rajarshimaitra opened this issue Jan 2, 2022 · 4 comments
Assignees
@rajarshimaitra

Comments

@rajarshimaitra
Copy link
Contributor

After porting the blogs and docs into new website, it seems there are rooms now to organize the documents better.

  • The bdk-cli section https://bitcoindevkit.org/bdk-cli/installation/ could use an introduction.

  • Many blog posts are essentially tutorials, and they can be moved to the tutorial section.

  • Adding more smaller tutorials (how-tos) for common tasks like running regtest nodes etc and linking them to other tutorials.

  • More detailing in the getting started page.

Other improvement ideas are welcome.

Opening this up as a tracking issue.
@ConorOkus
Copy link

Would also be great to add runnable self-contained examples to the bdk main repo similar to this - https://github.com/vercel/next.js/tree/canary/examples and link to those from the website 👍

@rajarshimaitra rajarshimaitra mentioned this issue Jan 6, 2022
Merged
3 tasks
@rajarshimaitra
Copy link
Contributor Author

@ConorOkus I opened bitcoindevkit/bdk#519 adding one example in bdk. Let me know if you meant this kind of examples.

@ConorOkus
Copy link

Yeah awesome, didn't realise there were some examples already in there so that's great

@notmandatory notmandatory moved this to In Progress in Documentation Roadmap Mar 15, 2022
notmandatory added a commit to bitcoindevkit/bdk that referenced this issue Mar 29, 2022
@notmandatory
Merge #519: Add wallet creation example using RPC
ff6db18 
8a98e69 Add rpc wallet creation example (rajarshimaitra)

Pull request description:

  ### Description

  As mentioned in bitcoindevkit/bitcoindevkit.org#83 (comment) it would be helpful
  to have wallet creation example code in the `example` directory.

  This is an attempt to create the most simplistic bdk wallet with a RPC backend and demonstrate receiving, creating, signing
  and broadcasting transaction.

  The code is a refinement of the RPC tutorial https://bitcoindevkit.org/blog/bitcoin-core-rpc-demo/ with more elaborate doc comments.

  ### Notes to the reviewers

  To automate the background RPC process `electrsd` is used which is already a `dev-dependency` of bdk.

  ### Checklists

  #### All Submissions:

  * [x] I've signed all my commits
  * [x] I followed the [contribution guidelines](https://github.com/bitcoindevkit/bdk/blob/master/CONTRIBUTING.md)
  * [x] I ran `cargo fmt` and `cargo clippy` before committing

ACKs for top commit:
  notmandatory:
    tACK 8a98e69

Tree-SHA512: f00c1ce57ef91c3d3ab2ce08af3571c41bbe98f18f705c61ba4217c2f8061196e5eaf6122742293cd6fa16939bbbfacd0f8506cd4151b55f19a05325fd94a74a
@thunderbiscuit
Copy link
Member

This issue is a bit stale, and all tutorials are being moved to the blog. We're also working on a standalone documentation site that will take the place of some of these tutorials (the book of bdk). Closing this issue now as part of a clean up of this repository.

@github-project-automation github-project-automation bot moved this from In Progress to Done in Documentation Roadmap Jan 12, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@rajarshimaitra rajarshimaitra

Labels
None yet
Projects
Documentation Roadmap
Status: Done
Milestone
No milestone
Development

No branches or pull requests
3 participants
@ConorOkus @rajarshimaitra @thunderbiscuit