Skip to content

Commit 2b49aa4

Browse files
authored
Merge pull request #13 from SongshGeo/dev
Adds i18n support to project configuration script and platform-specific config docs.
2 parents 8a84312 + 10ca892 commit 2b49aa4

35 files changed

+2493
-266
lines changed

.cursor/cache/architecture.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
<!--
2+
Purpose:
3+
- Record the project's high-level architecture (modules, boundaries, and key flows) as a quick reference.
4+
5+
Audience:
6+
- Contributors and reviewers who need context before making changes.
7+
8+
Usage:
9+
- Update this file when architectural decisions or major module interactions change.
10+
-->
11+
12+
# Architecture

.cursor/cache/model-design.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
<!--
2+
Purpose:
3+
- Describe the project's domain/data model design (core entities, relationships, and invariants).
4+
5+
Audience:
6+
- Developers implementing features that touch data shapes, validation, or persistence.
7+
8+
Usage:
9+
- Keep this aligned with code changes; prefer concise diagrams/examples and links to source-of-truth.
10+
-->
11+
# Project design

.cursor/cache/progress.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
<!--
2+
Purpose:
3+
- Track current implementation progress, open questions, and next steps during active development.
4+
5+
Audience:
6+
- Any contributor (or coding agent) coordinating ongoing work.
7+
8+
Usage:
9+
- Keep entries brief and actionable; remove outdated notes once resolved.
10+
-->
11+
# progress
Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,19 @@
1-
# Tech Stack
1+
<!--
2+
Purpose:
3+
- Summarize the chosen tech stack (libraries/tools) and the rationale for key selections.
4+
5+
Audience:
6+
- Contributors onboarding or evaluating dependency/stack changes.
7+
8+
Usage:
9+
- Update when adding/removing major dependencies or changing runtime/build tooling.
10+
-->
11+
# Tech-stack documentation
212

313
## Develop Env Stack
414

515
- Python 3.10–3.13 (PEP 563 via `future-annotations`, typing support via `typing-extensions`).
6-
- Poetry build (PEP 621) with runtime deps only `typing-extensions`, `future-annotations`.
16+
- `uv` build (PEP 621) with runtime deps only `typing-extensions`, `future-annotations`.
717
- Tooling via pre-commit: Black (code + Jupyter), Isort (`--profile=black`), Ruff lint/format, Flake8 (custom ignores/line length), nbstripout (keep outputs), check-ast/EOL/trailing-space.
818
- Quality gates: Mypy (`--ignore-missing-imports`), Interrogate (docstring coverage fail-under 80), docstrings follow Google style.
919
- Testing harness: Pytest; task orchestration: Tox; notebooks: ipykernel/ipywidgets.

.cursor/rules/cursorrules.mdc

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,4 +26,5 @@ from _pytest.logging import LogCaptureFixture
2626
from _pytest.monkeypatch import MonkeyPatch
2727
from pytest_mock.plugin import MockerFixture
2828

29-
Before you begin, carefully read all documents in ./cache/
29+
Before you begin, carefully read all documents in .cursor/cache/
30+
Avoid using "try...except" syntax to prevent exceptions from being silenced.

.github/workflows/docs.yml

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,10 +33,11 @@ jobs:
3333
source $HOME/.cargo/env
3434
uv sync --all-extras
3535
36-
- name: Build documentation
36+
- name: Build documentation (en + zh)
3737
run: |
3838
source $HOME/.cargo/env
39-
uv run mkdocs build
39+
uv run mkdocs build -f mkdocs.en.yml
40+
uv run mkdocs build -f mkdocs.zh.yml
4041
4142
- name: Setup Pages
4243
uses: actions/configure-pages@v4

.github/workflows/release-please.yml

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ permissions:
1111
id-token: write
1212

1313
jobs:
14-
# 创建 release
14+
# Create release
1515
release-please:
1616
runs-on: ubuntu-latest
1717
outputs:
@@ -24,7 +24,7 @@ jobs:
2424
release-type: python
2525
package-name: ${project_name}
2626

27-
# 发布到 pypi
27+
# Publish to PyPI
2828
publish-pypi:
2929
needs: release-please
3030
runs-on: ubuntu-latest
@@ -49,17 +49,15 @@ jobs:
4949
uv build
5050
uv publish
5151
52-
# 打包源码, 上传到 release
52+
# Package source and upload to release (optional)
5353
# build-and-attach-assets:
5454
# needs: release-please
5555
# runs-on: ubuntu-latest
5656
# if: ${{ needs.release-please.outputs.release_created }}
5757
# steps:
5858
# - uses: actions/checkout@v3
59-
6059
# - name: Zip src folder
6160
# run: zip -r src.zip src/
62-
6361
# - name: Upload Release Asset
6462
# env:
6563
# GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

0 commit comments

Comments
 (0)