Skip to content

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

Open
Miyamura80 wants to merge 1 commit intomainfrom
fix-documentation-drift-15517131570510791218
Open

docs: fix outdated documentation (automated weekly drift check)#147
Miyamura80 wants to merge 1 commit intomainfrom
fix-documentation-drift-15517131570510791218

Conversation

@Miyamura80
Copy link
Owner

Fix outdated documentation rules according to OUTDATED_DOCUMENTATION_GUIDELINE.md by targeting verifiable factual inaccuracies only.

Changes:

  1. Updated docs/README.md to use bun run dev instead of npm/pnpm/yarn instructions, which aligns with Makefile and bun.lock.
  2. Replaced the "etc." reference in README.md for the make ci description with the concrete list of commands the Makefile target actually runs.

All changes verified with make lint_links and make test.


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

- `docs/README.md`: Updated local development instructions to use `bun` instead of `npm`/`yarn`/`pnpm` to match the actual tooling setup (`bun.lock`, `Makefile`).
- `README.md`: Updated the `make ci` description to accurately list the exact tools it runs (`ruff`, `vulture`, `import_lint`, `ty`, `docs_lint`, `lint_links`, `check_deps`) instead of a vague "etc.", ensuring exact factual accuracy based on `Makefile`.

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 Mar 18, 2026

Greptile Summary

This PR fixes two small documentation inaccuracies as part of an automated weekly drift check, ensuring the docs stay in sync with the actual project tooling.

  • README.md: The make ci bullet now lists the concrete targets (ruff, vulture, import_lint, ty, docs_lint, lint_links, check_deps) instead of the vague "etc." — verified against Makefile line 251.
  • docs/README.md: The dev-server instructions are consolidated to bun run dev, removing the now-irrelevant npm/pnpm/yarn alternatives — consistent with docs/bun.lock and the Makefile docs target (cd docs && bun run dev).

Confidence Score: 5/5

  • Safe to merge — only documentation strings are changed, no functional code is touched.
  • Both documentation changes are verifiably accurate: the make ci target list matches the Makefile exactly, and bun run dev aligns with docs/bun.lock and the Makefile docs target. No logic, no tests, no configs altered.
  • No files require special attention.

Important Files Changed

Filename Overview
README.md Updated make ci description to enumerate the exact Makefile dependencies (ruff, vulture, import_lint, ty, docs_lint, lint_links, check_deps) instead of vague "etc." — matches Makefile line 251 exactly.
docs/README.md Replaced the npm/pnpm/yarn dev-server options with the single bun run dev command, matching the docs/bun.lock lockfile and Makefile docs target.

Last reviewed commit: "docs: fix outdated d..."

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