Skip to content

docs(i18n): add Simplified Chinese rule index - #104

Merged
FROWNINGdev merged 1 commit into
FROWNINGdev:mainfrom
harbinresearcher:docs/zh-rule-index
Sep 11, 2026
Merged

FROWNINGdev merged 1 commit into
FROWNINGdev:mainfrom
harbinresearcher:docs/zh-rule-index

Conversation

@harbinresearcher

@harbinresearcher harbinresearcher commented Sep 11, 2026

Copy link
Copy Markdown
Contributor

Problem

The Simplified Chinese locale already includes translations for DOL021 and DOL022, but it has no locale-level rule index. The Chinese README links the pages individually without a dedicated entry point that describes the locale's partial coverage.

Solution

Add a small partial-locale index based on the current Italian index structure. It lists the translated rules with canonical metadata, states that the locale is incomplete, and links readers to the full English reference.

Changes

  • Add the Simplified Chinese rule index for DOL021 and DOL022.
  • Link the index from the date/time row in the Chinese README.
  • Record the documentation addition under Unreleased in the changelog.

Testing

  • npm test — 242 tests passed.
  • Python CLI tests — 475 passed, 2 skipped, 41 subtests passed.
  • Ruff and mypy passed.
  • Verified every relative link target and ran git diff --check.

Notes for Reviewer

This intentionally covers only the index chunk from issue #81. It does not translate additional rule pages or close the broader issue. Category, severity, and applicability values match the canonical English rule reference.

Refs #81.

Summary by CodeRabbit

  • Documentation
    • Added a Chinese-language rules reference index for Django ORM Lens.
    • Documented the DOL021 and DOL022 datetime rules, including their severity and applicability.
    • Linked the Chinese README’s Date/Time category to the new localized rules reference.
    • Updated the unreleased changelog with these documentation additions.

@coderabbitai

coderabbitai Bot commented Sep 11, 2026

Copy link
Copy Markdown

Review Change StackReview Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Advanced

Run ID: 301daba3-be14-43ba-b9c3-3ce502dfd5ef

📥 Commits

Reviewing files that changed from the base of the PR and between f22d668 and dba7370.

📒 Files selected for processing (3)
  • CHANGELOG.md
  • docs/i18n/README.zh.md
  • docs/i18n/rules/zh/README.md

Included review availability: Your plan provides up to 1 included review per hour; 0 remain after this review.


📝 Walkthrough

Walkthrough

The change adds a Chinese rules index for DOL021 and DOL022, links the Date/Time category to the index, and records the documentation update in the changelog.

Changes

Chinese rule index documentation

Layer / File(s) Summary
Add Chinese rule index and navigation
docs/i18n/rules/zh/README.md, docs/i18n/README.zh.md, CHANGELOG.md
Adds the Chinese datetime rules index, links the Date/Time category to it, and records the update under the unreleased changelog entries.

Priority: ⬇️ Low

Estimated code review effort: 1 (Trivial) | ~5 minutes

Change: Other

Suggested reviewers: frowningdev

Merge Risk: ⚪ Minimal · up to dba73

The localized rule index and navigation are ready to merge.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly and concisely describes the main change: adding a Simplified Chinese rule index.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@FROWNINGdev

Copy link
Copy Markdown
Owner

Thanks @harbinresearcher! I checked the relative links and the DOL021/DOL022 metadata against the English index — everything matches. Merging.

If you'd like to keep going, the DOL001–DOL007 queryset family from #81 is still open; the Italian set in docs/i18n/rules/it/ is the closest template (same index shape, just add rows as pages land).

@FROWNINGdev
FROWNINGdev enabled auto-merge (squash) September 11, 2026 18:41
@FROWNINGdev
FROWNINGdev merged commit 86a7396 into FROWNINGdev:main Sep 11, 2026
18 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants