bytedance / bytedance/agentkit-samples

README dependency versions diverge from sample manifests

Open
#263 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
Python
Stars
454
Forks
96
PR merge metrics
No merged PRs in 30d

Description

### Description

Eight tracked README files contain 18 dependency-version statements or install commands that contradict the dependency manifest in the same sample directory.

Confirmed groups at commit `0890278a6571e4190c1ab8cacd9becc147f74d9c`:

1. `python/01-tutorials/01-agentkit-runtime/image_video_tools/README.md` and `README_en.md`
- README: AgentKit 0.5.10, Google ADK 1.32.0, VeADK 0.5.37
- `pyproject.toml`: AgentKit 0.8.1, Google ADK 2.2.0, VeADK 1.0.10
2. `python/02-use-cases/ad_video_gen/README.md` and `README_en.md`
- README: AgentKit 0.5.10 and VeADK 0.5.37
- `pyproject.toml`: AgentKit 0.8.1 and VeADK 1.0.10
3. `python/02-use-cases/partners/video_breakdown_agent/README.md`
- install examples: AgentKit 0.5.1
- `pyproject.toml`: AgentKit 0.8.1
4. `python/02-use-cases/travel_planner/README.md` and `README_en.md`
- install examples: AgentKit 0.3.2
- `requirements.txt`: AgentKit 0.8.1
5. `python/02-use-cases/video_breakdown_agent/README.md`
- install examples: AgentKit 0.5.1
- `pyproject.toml`: AgentKit 0.8.1

The bilingual copies repeat the same stale versions, so updating only one language would leave the documented setup inconsistent.

### Reproduction

Compare each version table/install command above with the colocated `pyproject.toml` or `requirements.txt`. A repository-wide exact-version extraction reports 18 stale occurrences across the eight README files.

### Expected behavior

README dependency tables and manual installation commands should match the authoritative manifest used by the sample, or avoid duplicating exact versions when the manifest is intentionally the single source of truth.

### Impact

Users following the README can construct an environment substantially older than the sample code and lock/configuration expect, including major-version differences for Google ADK and VeADK.

### Duplicate check

Open/closed issues, all PR states, relevant commit history, and version/root-cause terms were searched. Open PR #240 changes several dependency manifests but does not update these README claims, so it is a related moving dependency change rather than an equivalent documentation fix.

### Why there is no PR in this audit

PR #240 may change the target manifest versions again. Updating the READMEs to the current baseline while that dependency upgrade is unresolved could immediately make them stale a second time or conflict with the maintainer's intended versions. Once the manifest target is settled, all eight localized/source documents should be updated together and checked by a manifest-vs-doc consistency test.

Contributor guide

Open the contributing guide

Research direction

First check PR #240 and confirm the settled dependency versions before editing. Compare the eight listed README.md and README_en.md files with their colocated pyproject.toml or requirements.txt files, then update all 18 stale occurrences together and verify them with a manifest-vs-documentation consistency check.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Active
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.