Repository navigation
docs: add troubleshooting, getting started, and a changelog - #29
Open
thebrandonlucas wants to merge 1 commit into
Open
thebrandonlucas wants to merge 1 commit into
thebrandonlucas wants to merge 1 commit into
Conversation
thebrandonlucas
added this pull request to stack #25
October 13, 2026 19:09
thebrandonlucas
force-pushed
the
docs/cli-troubleshooting
branch
2 times, most recently
from
October 19, 2026 13:14
2d19d0b to
61af70c
Compare
thebrandonlucas
force-pushed
the
docs/cli-troubleshooting
branch
4 times, most recently
from
October 19, 2026 18:39
a0df0b3 to
d6b3fc3
Compare
thebrandonlucas
force-pushed
the
docs/cli-troubleshooting
branch
2 times, most recently
from
October 19, 2026 19:11
b4ca251 to
39b720c
Compare
thebrandonlucas
force-pushed
the
docs/cli-troubleshooting
branch
from
October 19, 2026 19:19
39b720c to
ba7701d
Compare
This was referenced Oct 19, 2026
docs/guides/troubleshooting.md is keyed by exit code and by each credential_problem name, with the fix for each; a test requires an entry for every exit code and every CredentialProblem, which an exhaustive match keeps complete. docs/getting-started.md walks from install to a settled mutinynet payment and a scripted receive. CHANGELOG.md starts with the changes since 0.1.0. A pull request template and a Changelog workflow ask for an Unreleased entry: the workflow fails a PR that changes src/cli.rs or api/commands.json without CHANGELOG.md, unless it has the no-changelog label. AGENTS.md states the rule. The docs example checks now also read CHANGELOG.md and the tutorial, so their commands parse and their changes pass as offline dry runs.
thebrandonlucas
force-pushed
the
docs/cli-troubleshooting
branch
from
October 20, 2026 00:20
ba7701d to
01df020
Compare
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.
Stack: master ← #20 ← #22 ← #24 ← #19 ← #26 ← #27 ← #28 ← this PR. Plan 07, phase 5. Builds on the hints from #24, which the troubleshooting entries explain.
docs/guides/troubleshooting.md): an entry per exit code and percredential_problem(no_credential,multiple_credentials,unknown_credential,empty_api_key,bound_elsewhere), plus expired logins, API-key discovery, HTTP 401/403, a locked OS credential store, andfeature_flag_disabled. Each heading is the literal code or message, so search finds it.docs/getting-started.md): one path from install through login, a saved profile, a mutinynet wallet, a received 1,000 sats, and the same receive scripted with--jsonandjq.CHANGELOG.md(Keep a Changelog style, hand-written) seeded with the changes since 0.1.0, including this stack.Changelogworkflow that fails a PR changingsrc/cli.rsorapi/commands.jsonwithoutCHANGELOG.md, unless it has theno-changeloglabel (it reruns on label changes, so it is a separate workflow from CI); and the rule inAGENTS.md.Tests: troubleshooting must have an entry for every exit code and every
CredentialProblem; an exhaustivematchmakes a new problem fail to compile until it has one. The docs example checks now also readCHANGELOG.mdand the tutorial, so the tutorial's commands parse and its changes pass as offline dry runs.Validation:
cargo fmt --check,cargo clippy --locked --all-targets -- -D warnings,cargo machete --with-metadata,cargo test --locked(98 unit, 69 integration), andpython3 scripts/check-coverage.py.Not done here:
no-changeloglabel does not exist in the repository yet.