Skip to content

docs(agents): repair module paths that no longer exist - #908

Closed
lihongyuan99 wants to merge 2 commits into
TencentCloud:developfrom
lihongyuan99:docs/agents-stale-module-paths
Closed

lihongyuan99 wants to merge 2 commits into
TencentCloud:developfrom
lihongyuan99:docs/agents-stale-module-paths

Conversation

@lihongyuan99

@lihongyuan99 lihongyuan99 commented Sep 21, 2026 •

Copy link
Copy Markdown
Contributor

Summary

AGENTS.md pointed at module paths that no longer exist, so an agent following the doc would open files that are not there. Each replacement below was checked by resolving the path against src/octop/ on develop 4c3bf764:

stale in AGENTS.md actual
infra/db/_base infra/db/repos/_base.py
infra/gateway/processor.py infra/gateway/process/processor.py (GlobalProcessor at :127)
api/errors.py api/app.py _install_exception_handlers() (:77)
cli/run_cmd.py, cli/init_cmd.py, cli/backup_cmd.py, cli/*_cmd.py cli/commands/run.py, cli/commands/init.py, cli/commands/backup.py, cli/commands/*.py
infra/gateway/threads.py row's api/routers/chat.py api/routers/chat/ (package)
infra/agents/manager.py (bare) infra/agents/manager.py (AgentManager.start at :887)

The database paragraph said "bump the version assertion in tests/unit/db/test_db_pool.py (currently v == 7)". The literal was wrong twice over while this PR was open (v == 16 → v == 17), so it now points at the test that pins the number instead of restating it.

After rebasing, every src/octop/**.py path referenced in AGENTS.md resolves — machine-checked with a regex pass over the file against the working tree, which reports zero unresolvable references.

Target branch

develop (checked per CONTRIBUTING: main only takes releases/hotfixes).

Type of change

  • Documentation only change

Test plan

Rebased onto origin/develop 4c3bf764; AGENTS.md is the only file in the diff (git diff --stat origin/develop..HEAD → 1 file changed, 12 insertions(+), 11 deletions(-)).

  • uv run ruff check src tests → All checks passed!
  • uv run ruff format --check src tests → 1074 files already formatted
  • uv run mypy src/octop → Success: no issues found in 527 source files
  • uv run pytest -q -m "not live" -n auto → 3820 passed, 18 skipped, 20 warnings in 211.02s
  • Path-resolution check over AGENTS.md: stale .py references after rebase = NONE

No shell script or CLI surface is touched, so there is no bash 3.2 / 5.x behaviour difference to report; the two conflicted hunks were resolved by keeping every develop line (including the new infra/history/ row) and re-applying only the path corrections.

Checklist

  • My code follows the style of this repository
  • I have performed a self-review of my code
  • Documentation-only change: no tests required
  • I have updated the CHANGELOG if this change is user visible — N/A, internal module paths

@jubaoliang

Copy link
Copy Markdown
Collaborator

修 AGENTS.md 过期路径方向好,但有一处必须改:

文中把 schema 断言写成 v == 16,当前 develop 已是 v == 17(tests/unit/db/test_db_pool.py)。请改成 17(或改成「见该测试文件当前断言」以免再过期),再合。

@jubaoliang jubaoliang closed this Sep 22, 2026
@jubaoliang jubaoliang reopened this Sep 22, 2026
lihongyuan99 added a commit to lihongyuan99/Octop that referenced this pull request Sep 22, 2026
The review on TencentCloud#908 caught that `v == 16` was already stale: the number is
derived state, and `017_thread_conversation_mode` landed while this PR sat.
Name the test that holds the value instead of copying it, so the next
migration cannot rot this sentence again.
@lihongyuan99

Copy link
Copy Markdown
Contributor Author

Done in 06b8920 — instead of v == 17 I dropped the literal and pointed at the test that pins it, since the number moved from 16 to 17 while this PR was open. Happy to switch back to the explicit 17 if you'd rather see it spelled out.

lihongyuan99 added a commit to lihongyuan99/Octop that referenced this pull request Sep 26, 2026
The review on TencentCloud#908 caught that `v == 16` was already stale: the number is
derived state, and `017_thread_conversation_mode` landed while this PR sat.
Name the test that holds the value instead of copying it, so the next
migration cannot rot this sentence again.
@lihongyuan99
lihongyuan99 force-pushed the docs/agents-stale-module-paths branch from 06b8920 to 7088cb0 Compare September 26, 2026 04:45
Six paths in the layer tables and the "Where to look" map point at modules that
are gone after the infra/ reorganisations, and the schema-version hint still
says v == 7 while tests/unit/db/test_db_pool.py asserts 16. Each replacement is
the module that actually holds the described code today.
The review on TencentCloud#908 caught that `v == 16` was already stale: the number is
derived state, and `017_thread_conversation_mode` landed while this PR sat.
Name the test that holds the value instead of copying it, so the next
migration cannot rot this sentence again.
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