fix: revert README to v1.x documentation on main (#1971)

Co-authored-by: Marcelo Trylesinski <marcelotryle@gmail.com>

.github/workflows/shared.yml

@@ -80,4 +80,4 @@ jobs:
         run: uv sync --frozen --all-extras --python 3.10
 
       - name: Check README snippets are up to date
-        run: uv run --frozen scripts/update_readme_snippets.py --check
+        run: uv run --frozen scripts/update_readme_snippets.py --check --readme README.v2.md

.pre-commit-config.yaml

@@ -42,7 +42,7 @@ repos:
         types: [python]
         language: system
         pass_filenames: false
-        exclude: ^README\.md$
+        exclude: ^README(\.v2)?\.md$
       - id: pyright
         name: pyright
         entry: uv run --frozen pyright
@@ -59,5 +59,5 @@ repos:
         name: Check README snippets are up to date
         entry: uv run --frozen python scripts/update_readme_snippets.py --check
         language: system
-        files: ^(README\.md|examples/.*\.py|scripts/update_readme_snippets\.py)$
+        files: ^(README\.v2\.md|examples/.*\.py|scripts/update_readme_snippets\.py)$
         pass_filenames: false

pyproject.toml

@@ -123,7 +123,7 @@ executionEnvironments = [
 [tool.ruff]
 line-length = 120
 target-version = "py310"
-extend-exclude = ["README.md"]
+extend-exclude = ["README.md", "README.v2.md"]
 
 [tool.ruff.lint]
 select = [

scripts/update_readme_snippets.py

@@ -144,7 +144,8 @@ def main():
     parser.add_argument(
         "--check", action="store_true", help="Check mode - verify snippets are up to date without modifying"
     )
-    parser.add_argument("--readme", default="README.md", help="Path to README file (default: README.md)")
+    # TODO(v2): Drop the `--readme` argument when v2 is released, and set to `README.md`.
+    parser.add_argument("--readme", default="README.v2.md", help="Path to README file (default: README.v2.md)")
 
     args = parser.parse_args()
 

tests/test_examples.py

@@ -96,7 +96,8 @@ async def test_desktop(monkeypatch: pytest.MonkeyPatch):
             assert "/fake/path/file2.txt" in content.text
 
 
-@pytest.mark.parametrize("example", find_examples("README.md"), ids=str)
+# TODO(v2): Change back to README.md when v2 is released
+@pytest.mark.parametrize("example", find_examples("README.v2.md"), ids=str)
 def test_docs_examples(example: CodeExample, eval_example: EvalExample):
     ruff_ignore: list[str] = ["F841", "I001", "F821"]  # F821: undefined names (snippets lack imports)