-
Notifications
You must be signed in to change notification settings - Fork 70
Closed
Description
This issue opens the discussion around removing the tutorials section of the website. Here are some of the reasons I think this is a good idea:
- Tutorials have mostly been a source of pain and confusion for new users. Their core flaw is that they do not age well. We've introduced breaking changes on most releases over the years (for good reasons! we're growing and fixing things!), and the upcoming 1.0 API basically obsoletes all tutorials altogether.
- The differences between the tutorials and the blog posts is that the blog posts are dated, and provide a specific opinion/view/insights into bdk at a specific point in time, rather than the promise of an evergreen walkthrough of how to perform a specific task.
- The tutorials are of varying quality, both in grammar and spelling, and maintaining them has proven to be work that no one on the core team is truly interested in picking up (I might be wrong on this; speak up if you disagree and would like to take the task on).
What should we do to provide tutorial-like instruction on bdk moving forward?
- One way we could keep some of the turtorials alive is by transforming them into blog posts (only the ones deemed interesting for archival purposes, or the ones where the author is interested in providing an updated version).
- Link to tutorials and blog posts on other websites (many developers have written extensively about bdk over the years and given example codebases, blog posts, etc. Those can be referenced in order to give them discoverability, while not taking on the burden of maintaining them.
- Love and care should be dedicated to a specific resource the team intends to maintain moving forward. I suggest the book-of-bdk for this. This is not intended to replace the tutorials, but should provide a starting point for developers intending to use bdk.
reezConorOkus
Metadata
Metadata
Assignees
Labels
No labels