docs/debug-handbook: create new debug run books for developers to help pattern match common issues and knowledge #1739
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
In this commit, we add a README for a new area of documentation intended for active developers of the project. The goal of this new set of docs is to capture all the hard earned wisdom that devs gain while debugging a non-trivial issue. It's meant to serve as a run book to allow for rapid pattern matching to identify a routine issue, along with a guided path to aide in debugging. This should also be great for agents as well, since they can use them to locate issues that they would otherwise need some prodding to figure out.
Roasbeef
added
documentation
Pull Request Test Coverage Report for Build 16980805330Details
💛 - Coveralls |
|
Landing this as it's purely additive docs. |
github-project-automation
bot
moved this from 🏗 In progress
to ✅ Done
in Taproot-Assets Project Board
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
In this PR, we add a README for a new area of documentation intended
for active developers of the project. The goal of this new set of docs
is to capture all the hard earned wisdom that devs gain while debugging
a non-trivial issue. It's meant to serve as a run book to allow for
rapid pattern matching to identify a routine issue, along with a guided
path to aide in debugging.
This should also be great for agents as well, since they can use them to
locate issues that they would otherwise need some prodding to figure
out.
The first one added is intended to devs find PSBT signing related issues more quickly. I ran into this during the dev of #1675 to get the itests working properly. It relies on some deeper knowledge of: PSBTs, the way lnd signs them, where the code lives, the logs to watch for, etc. So I figured I'd document it.
I also made a sub-agent that can be useful for such tasks.