Skip to content

DOPE-696: Correct CLAUDE.md claims that do not match the code - #211

Merged
marconetsf merged 1 commit into
feature/DOPE-696-claude-md-harnessfrom
docs/claude-md-corrections
Oct 5, 2026
Merged

marconetsf merged 1 commit into
feature/DOPE-696-claude-md-harnessfrom
docs/claude-md-corrections

Conversation

@marconetsf

@marconetsf marconetsf commented Oct 1, 2026 •

Copy link
Copy Markdown
Contributor

Jira: DOPE-696 (sub-task DOPE-699)

Problem

Targets #204. Several CLAUDE.md claims do not match the code, mostly in sections that PR left untouched.

Change

  • install.sh installs the Docker version by default (install.sh:152); a source build needs --native.
  • State machine: STOPPED is the initial state (plc_state_manager.cpp:47), starts and stops go through the TRANSITIONING states, and INIT is no longer set (:1025-1031). Documents when EMPTY and ERROR are published.
  • IPC: the log socket is served by Python (webserver/unixserver.py) and the C side is the client (utils/log.c).
  • python3 -m webserver.app also spawns plc_main (app.py:75-82); the command now uses the venv interpreter directly, as start_openplc.sh does.
  • isort runs with --profile=black; ruff-format is listed.
  • CI scope: push and dispatch triggers, the shellcheck file list, the --native caller check, and the suites that do not run in CI.
  • compile.sh produces new_libplc.so, renamed by compile-clean.sh.
  • scan_cycle_manager.c and debug_handler.c descriptions.
  • Jira keys stay out of commit messages, although the example in docs/DEVELOPMENT.md puts one in the footer.

Validation

Every claim was checked against the cited files. Documentation only.

🤖 Generated with Claude Code

Default install is Docker; source builds need --native. The state machine
starts in STOPPED and moves through the TRANSITIONING states; INIT is no
longer set. The log socket is served by Python, not C. Also corrects the
web server command, isort profile, CI scope, compiled library name, the
scan cycle and debug handler descriptions, and keeps Jira keys out of
commit messages.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@Thiago-Pio-Autonomy Thiago-Pio-Autonomy changed the title Correct CLAUDE.md claims that do not match the code DOPE-696: Correct CLAUDE.md claims that do not match the code Oct 2, 2026
@marconetsf
marconetsf merged commit c3f9eca into feature/DOPE-696-claude-md-harness Oct 5, 2026
3 checks passed
@thiagoralves
thiagoralves deleted the docs/claude-md-corrections branch October 5, 2026 19:23
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.

2 participants