You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
Commit 972c549
Browse filesBrowse the repository at this point in the historyBrowse files
docs: tidy up website tooling and repo config (#1126)
Website tooling and repo config cleanup, same as crawlee-python#2327 and
apify-sdk-python#1181.
- Website code is linted with type-aware oxlint (new
`website/tsconfig.json`), and warnings fail CI.
- Removed unused website deps and aligned version ranges with the
lockfile.
- YAML: 2-space indent, no quotes unless needed, double quotes when they
are.
- markdownlint: default 2-space list indent (as in apify-docs) and
fenced code blocks only.
- Fixed the `.editorconfig` YAML glob.
*✍️ Drafted by Claude Code*
Copy file name to clipboardExpand all lines: .rules.md
+8-8Lines changed: 8 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -82,8 +82,8 @@ Each input-side TypedDict ships in two casings: snake_case (`RequestResourceDict
82
82
- Generated by `datamodel-code-generator` from the OpenAPI spec at `https://docs.apify.com/api/openapi.json` (config in `pyproject.toml` under `[tool.datamodel-codegen]`, aliases in `datamodel_codegen_aliases.json`)
83
83
- After generation, `scripts/postprocess_generated_models.py` is run to apply additional fixes
84
84
- To regenerate locally:
85
-
- From the live published spec: `uv run poe generate-models`
86
-
- From a local spec file: `uv run poe generate-models-from-file path/to/openapi.json`
85
+
- From the live published spec: `uv run poe generate-models`
86
+
- From a local spec file: `uv run poe generate-models-from-file path/to/openapi.json`
87
87
-`scripts/openapi_spec.py` downloads the spec once into git-ignored `tmp/openapi.json` — both codegen passes read that copy, so a spec redeployed mid-run can't leave the generated files describing two different inputs — then records its `info.version` in `pyproject.toml` under `[tool.apify.openapi-spec]`
88
88
- That version is a **coarse marker, not a content identity**: the spec is served latest-only, and apify-docs bumps `components/version.yaml` in a follow-up `[skip ci]` commit, so a deploy can publish new content under the old stamp. A moved value proves the spec changed; an unchanged value proves nothing
89
89
- Recording is unconditional; the nightly workflow keeps it honest by committing nothing unless the models changed. A local `generate-models` that only moves that line should be dropped, not committed alone. `generate-models-from-file` leaves the line alone, so models from a candidate spec must not be committed
@@ -99,12 +99,12 @@ Each input-side TypedDict ships in two casings: snake_case (`RequestResourceDict
99
99
-**Docstrings**: Google style format, single backticks for inline code references (`` `ApifyClient` `` not ``` ``ApifyClient`` ```)
100
100
-**Imports**: `from __future__ import annotations` used throughout
101
101
-**Commits**: [Conventional Commits](https://www.conventionalcommits.org/) format. Choose the type based on *what* changed, not just *why*:
102
-
-`feat:` / `fix:` / `perf:` / `refactor:` / `style:` — **source code only**; these trigger a release and appear in the changelog
103
-
-`test:` — test additions or changes (no release triggered)
104
-
-`docs:` — documentation changes; also triggers a doc release on master
105
-
-`ci:` — CI/workflow changes
106
-
-`chore:` — dependency bumps, tooling, generated files (e.g. model regeneration PRs), and other housekeeping
107
-
-`build:` — build system changes
102
+
-`feat:` / `fix:` / `perf:` / `refactor:` / `style:` — **source code only**; these trigger a release and appear in the changelog
103
+
-`test:` — test additions or changes (no release triggered)
104
+
-`docs:` — documentation changes; also triggers a doc release on master
105
+
-`ci:` — CI/workflow changes
106
+
-`chore:` — dependency bumps, tooling, generated files (e.g. model regeneration PRs), and other housekeeping
0 commit comments