Skip to content

chore: alter doctor output#2

Closed
goodroot wants to merge 1 commit into
mainfrom
goodroot/doc-fix
Closed

chore: alter doctor output#2
goodroot wants to merge 1 commit into
mainfrom
goodroot/doc-fix

Conversation

@goodroot
Copy link
Copy Markdown
Member

No description provided.

@github-actions
Copy link
Copy Markdown

Continue PR Review

Automated review via Continue CLI run through opub.

Summary

This is a README-only change that updates sample/status output from session state: active to a concrete session-file presence string. No direct code, test, or security changes are visible from the provided diff. The main risk is documentation drift: this wording may blur the distinction between a merely present local session file and an actually active/linked session, which matters for opub session-linking semantics.

Findings

  • The new example may weaken session-state semantics. session state: active communicated runtime state, while session state: present (.../session.json) communicates filesystem presence. For opub, a present session file is not equivalent to an active linked session; docs should avoid implying that local state-file existence proves an active or linked run.
  • The example now exposes a more specific local state path shape (~/.local/state/opub/repos/.../targets/codex/session.json). While not a secret, documenting internal path structure can ossify implementation details and may encourage consumers to depend on a path instead of supported status fields/APIs.
  • No tests are shown for this behavioral/documentation shift. If CLI output was intentionally changed, there should be coverage ensuring session reporting preserves the invariant between configured/present state and active/linked state.

Suggested follow-ups

  • Clarify in the README whether present means only that a local session file exists, and explicitly state that it does not imply an active or linked funded-work session.
  • If the CLI output changed, add/update tests for session-state reporting to distinguish at least: absent, present, active, and linked states where applicable.
  • Consider using a less implementation-specific placeholder in docs if the exact on-disk path is not part of the supported interface.

@goodroot
Copy link
Copy Markdown
Member Author

Err... hah! Ok, CI talked me out of it.

@goodroot goodroot closed this May 15, 2026
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.

1 participant