Skip to content

docs: add reproducible debugging guidance#505

Open
ded-furby wants to merge 1 commit into
codeforester:masterfrom
ded-furby:documentation/500-20260608-debugging-verification
Open

docs: add reproducible debugging guidance#505
ded-furby wants to merge 1 commit into
codeforester:masterfrom
ded-furby:documentation/500-20260608-debugging-verification

Conversation

@ded-furby

@ded-furby ded-furby commented Jun 7, 2026

Copy link
Copy Markdown

Summary

  • Add a Base-specific reproducible debugging workflow to docs/testing.md.
  • Document completion checks that require fresh validation evidence before merge.

Issue

Closes #500

Validation

  • git diff --check

Demo Impact

None. Documentation/process only.

Notes

Documentation-only change. Maintainer review is requesting a couple of small doc corrections before merge.

@ded-furby ded-furby requested a review from codeforester as a code owner June 7, 2026 20:42

@codeforester codeforester left a comment

Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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:

  1. In docs/testing.md, the runtime ownership bullet points to lib/shell/runtime/, which does not exist. Please change that to lib/bash/runtime/ for the runtime shell code, and keep lib/shell/ only for shell startup/profile snippets if you mention both.
  2. Please make the diagnostic guidance explicit that basectl check and basectl doctor are 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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Adopt Base-specific debugging and verification guidance

2 participants