docs: fix stale paths in CLAUDE.md and the UI README's transport description - #428
Open
michaelxu2288 wants to merge 1 commit into
Open
docs: fix stale paths in CLAUDE.md and the UI README's transport description#428michaelxu2288 wants to merge 1 commit into
michaelxu2288 wants to merge 1 commit into
Conversation
…ription
CLAUDE.md pointed at agentex/scripts/lint_migrations.py (the linter lives at
agentex/scripts/ci_tools/migration_lint.py, as migration-lint.yml runs it, and
its flag is --base, not --base-ref) and at a database/models/ directory that
does not exist (the SQLAlchemy models are in src/adapters/orm.py). The UI README
described live updates as WebSocket subscriptions; the dev UI subscribes over
the HTTP event stream (GET /tasks/{id}/stream) through the BFF proxy.
Claude-Session: https://claude.ai/code/session_01HCVKnA7LeJZ44nxZz1uzF3
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.
What
CLAUDE.mdpointed atagentex/scripts/lint_migrations.pyand a--base-refflag; the migration linter lives atagentex/scripts/ci_tools/migration_lint.py(whatmigration-lint.ymlruns) and its flag is--base.CLAUDE.mdtold contributors to edit SQLAlchemy models indatabase/models/, which does not exist; the models live insrc/adapters/orm.py.agentex-ui/README.mddescribed live updates as WebSocket subscriptions. The dev UI subscribes over the HTTP event stream (GET /tasks/{id}/streamvia theagentexclient withstream: true, proxied by the BFF route); there is no WebSocket in the UI.Why
These are the first places a new contributor is sent by the repo's own instructions, and each one currently points somewhere that does not exist or describes the wrong mechanism.
Test
Docs-only. Paths verified against the tree and
.github/workflows/migration-lint.yml; transport verified inhooks/custom-subscribe-task-state.tsxandnode_modules/agentex/resources/tasks.js.https://claude.ai/code/session_01HCVKnA7LeJZ44nxZz1uzF3
The documentation corrections appear safe to merge.
Summary
agentex/src/adapters/orm.py.Reviews (1) · Last reviewed commit: "docs: fix stale paths in CLAUDE.md and t..."