From ef9c68319695f339ca6599fd54af4989c62dfca8 Mon Sep 17 00:00:00 2001 From: "google-labs-jules[bot]" <161369871+google-labs-jules[bot]@users.noreply.github.com> Date: Wed, 18 Mar 2026 17:08:52 +0000 Subject: [PATCH] docs: fix outdated documentation (automated weekly drift check) - `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> --- README.md | 2 +- docs/README.md | 6 +----- 2 files changed, 2 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index fa4a413..77ceb58 100644 --- a/README.md +++ b/README.md @@ -59,7 +59,7 @@ Opinionated Python stack for fast development. The `saas` branch extends `main` - `make all` - sync deps and run `main.py` - `make fmt` - runs `ruff format` + JSON formatting - `make test` - runs all tests in `tests/` -- `make ci` - runs all CI checks (ruff, vulture, ty, etc.) +- `make ci` - runs all CI checks (ruff, vulture, import_lint, ty, docs_lint, lint_links, check_deps) diff --git a/docs/README.md b/docs/README.md index 9b7bba9..da1999f 100644 --- a/docs/README.md +++ b/docs/README.md @@ -6,11 +6,7 @@ This is a Next.js application generated with Run development server: ```bash -npm run dev -# or -pnpm dev -# or -yarn dev +bun run dev ``` Open http://localhost:3000 with your browser to see the result.