docs: add reproducible debugging guidance#505
Open
ded-furby wants to merge 1 commit into
Open
Conversation
codeforester
requested changes
Jun 9, 2026
codeforester
left a comment
Owner
There was a problem hiding this comment.
Thanks for the contribution. This is directionally useful and the docs-only scope is right, but please fix two small documentation details before we merge:
- In
docs/testing.md, the runtime ownership bullet points tolib/shell/runtime/, which does not exist. Please change that tolib/bash/runtime/for the runtime shell code, and keeplib/shell/only for shell startup/profile snippets if you mention both. - Please make the diagnostic guidance explicit that
basectl checkandbasectl doctorare read-only/non-mutating commands. That is part of #500's acceptance criteria and helps keep the debugging workflow clear.
After those are updated, git diff --check is enough validation for this docs-only PR.
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
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
docs/testing.md.Issue
Closes #500
Validation
git diff --checkDemo Impact
None. Documentation/process only.
Notes
Documentation-only change. Maintainer review is requesting a couple of small doc corrections before merge.