Skip to content

docs: fix outdated documentation (automated weekly drift check)#135

Merged
Miyamura80 merged 2 commits intomainfrom
docs-fix-outdated-documentation-automated-weekly-drift-check-17096332281359517951
Feb 25, 2026
Merged

docs: fix outdated documentation (automated weekly drift check)#135
Miyamura80 merged 2 commits intomainfrom
docs-fix-outdated-documentation-automated-weekly-drift-check-17096332281359517951

Conversation

@Miyamura80
Copy link
Owner

This PR fixes outdated documentation identified during a weekly drift check.

Changes:

  1. CLAUDE.md: Corrected global_config attribute access pattern for LLM default model.
  2. manual_docs/branch_comparison.md: Updated feature matrix to reflect missing pytest-asyncio in main branch.
  3. docs/content/docs/index.mdx: Replaced nonexistent make setup command with uv sync and fixed incorrect file path for main.py.

PR created automatically by Jules for task 17096332281359517951 started by @Miyamura80

- CLAUDE.md: Update `global_config.llm_config.default_model` to `global_config.default_llm.default_model`
  - Evidence: `common/config_models.py` defines `DefaultLlm` (containing `default_model`) and `LlmConfig` (containing `retry`, `cache_enabled`) separately.
- manual_docs/branch_comparison.md: Change `pytest-asyncio` support for `main` from `✅` to `❌`
  - Evidence: `pyproject.toml` dependencies do not include `pytest-asyncio`, and `uv run pip list` confirms it is not installed.
- docs/content/docs/index.mdx: Replace `make setup` with `uv sync`
  - Evidence: `Makefile` does not contain a `setup` target.
- docs/content/docs/index.mdx: Replace `uv run python src/main.py` with `uv run python main.py`
  - Evidence: `main.py` resides in the project root, not in `src/`.

Co-authored-by: Miyamura80 <38335479+Miyamura80@users.noreply.github.com>
@google-labs-jules
Copy link
Contributor

👋 Jules, reporting for duty! I'm here to lend a hand with this pull request.

When you start a review, I'll add a 👀 emoji to each comment to let you know I've read it. I'll focus on feedback directed at me and will do my best to stay out of conversations between you and other bots or reviewers to keep the noise down.

I'll push a commit with your requested changes shortly after. Please note there might be a delay between these steps, but rest assured I'm on the job!

For more direct control, you can switch me to Reactive Mode. When this mode is on, I will only act on comments where you specifically mention me with @jules. You can find this option in the Pull Request section of your global Jules UI settings. You can always switch back!

New to Jules? Learn more at jules.google/docs.


For security, I will only act on instructions from the user who triggered this task.

@greptile-apps
Copy link
Contributor

greptile-apps bot commented Feb 25, 2026

Greptile Summary

This PR corrects three documentation drift issues identified during automated weekly checks:

  • CLAUDE.md: Fixed the config attribute access pattern from global_config.llm_config.default_model to global_config.default_llm.default_model to match the actual structure in common/global_config.yaml
  • docs/content/docs/index.mdx: Replaced nonexistent make setup command with uv sync and corrected the file path from src/main.py to main.py (the actual location in the repository)
  • manual_docs/branch_comparison.md: Updated the feature comparison matrix to accurately reflect that pytest-asyncio is missing from the main branch (❌) but present in the dev branch (✅)

All changes are purely documentation corrections with no code modifications. The fixes align with actual codebase structure and available commands.

Confidence Score: 5/5

  • This PR is safe to merge with no risk
  • All changes are documentation-only fixes that correct outdated references to match the actual codebase. No functional code is modified, and all corrections have been verified against the actual repository structure.
  • No files require special attention

Important Files Changed

Filename Overview
CLAUDE.md Fixed incorrect config path from llm_config.default_model to default_llm.default_model
docs/content/docs/index.mdx Corrected nonexistent make setup to uv sync and fixed path from src/main.py to main.py
manual_docs/branch_comparison.md Updated feature matrix to reflect pytest-asyncio missing from main branch

Last reviewed commit: 8190935

- CLAUDE.md: Update `global_config.llm_config.default_model` to `global_config.default_llm.default_model`
  - Evidence: `common/config_models.py` defines `DefaultLlm` (containing `default_model`) and `LlmConfig` (containing `retry`, `cache_enabled`) separately.
- manual_docs/branch_comparison.md: Change `pytest-asyncio` support for `main` from `✅` to `❌`
  - Evidence: `pyproject.toml` dependencies do not include `pytest-asyncio`, and `uv run pip list` confirms it is not installed.
- docs/content/docs/index.mdx: Replace `make setup` with `uv sync`
  - Evidence: `Makefile` does not contain a `setup` target.
- docs/content/docs/index.mdx: Replace `uv run python src/main.py` with `uv run python main.py`
  - Evidence: `main.py` resides in the project root, not in `src/`.

Co-authored-by: Miyamura80 <38335479+Miyamura80@users.noreply.github.com>
@Miyamura80 Miyamura80 merged commit b32e16b into main Feb 25, 2026
10 checks passed
@github-actions github-actions bot deleted the docs-fix-outdated-documentation-automated-weekly-drift-check-17096332281359517951 branch February 25, 2026 19:48
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