Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Kludex merged 5 commits into from
Jan 29, 2026
+2,762 −188
Merged

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

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
78149b5
fix: revert README to v1.x documentation on main branch
maxisbey Jan 29, 2026
75bad91
ci: exclude README.md from ruff and pre-commit linting checks
maxisbey Jan 29, 2026
d839d15
docs: add v1.x branch link to README banner
maxisbey Jan 29, 2026
d90dd11
Apply suggestion from @Kludex
Kludex Jan 29, 2026
9a96876
Apply suggestion from @Kludex
Kludex Jan 29, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/shared.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
4 changes: 2 additions & 2 deletions .pre-commit-config.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Loading
Loading