docs(bitcoin): improve CLI UX, fix heading structure, reorder Direct API sections#170
Merged
Conversation
…API sections Split the monolithic icp-cli block in the ckBTC section into individual copy-paste commands, deriving MY_PRINCIPAL automatically from the active identity instead of requiring manual substitution of a placeholder. Promoted UTXO selection from a lone h4 to a sibling h3, moved the working-example links to close out the Developer workflow section, and reordered Direct Bitcoin API sections so read operations (balance, UTXOs, fee percentiles, blockchain info) are grouped before the workflow and UTXO selection content. Fixed all em-dashes introduced in the previous PR.
Member
Author
|
Feedback addressed:
|
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Summary
CLI copy-paste UX
The
### Interact with ckBTC using icp-clisection previously had a single monolithic code block withYOUR-PRINCIPALliterals that required manual editing before every command. The section now:MY_PRINCIPALfrom the active identity in one setup block (icp identity get-principal) so it never needs to be typed or edited.$MY_PRINCIPALinterpolated via double-quote shell expansion.export RECIPIENT="<paste-recipient-principal>"at the top of the same block, keeping it a single copy-paste operation while making the placeholder explicit.Direct Bitcoin API section reordering
Previous order mixed monitoring utilities in with core read operations and placed
### Blockchain infoimmediately after### Available endpoints, before the developer's first instinct (get_balance,get_utxos). New order groups sections by purpose:Blockchain infois a monitoring/diagnostics call — it belongs after the core transaction-building reads, not before them.Developer workflow heading structure
#### UTXO selectionwas the only h4 in the entire file, sitting as a lone child under### Developer workflow. This:The fix promotes
#### UTXO selectionto### UTXO selectionas a sibling of### Developer workflow. The### Developer workflowsection now closes with the working-example links (which cover the full flow, not just UTXO selection), and step 3 in the numbered list links directly to#utxo-selectionfor readers who want to jump there.Em-dash cleanup
The previous PR (#169) introduced several em-dashes in new prose. All instances outside code blocks are replaced with colons, semicolons, or parentheses per the project's banned-terms rule.
Sync recommendation
Informed by
dfinity/examples— no source changes, documentation improvements only.