Merge upstream and sync multi-language documentation#5
Conversation
- Merged upstream 'jaywhj/mkdocs-document-dates' (v3.8.7) - Resolved conflicts in pyproject.toml, plugin.py, and utils.py - Preserved local timezone handling and HTML escaping logic - Synced English and Chinese documentation from upstream - Configured a documentation landing page in docs/index.md - Updated properdocs.yml with the new documentation structure - Verified changes with unit tests and documentation builds Co-authored-by: google-labs-jules[bot] <161369871+google-labs-jules[bot]@users.noreply.github.com>
|
👋 Jules, reporting for duty! I'm here to lend a hand with this pull request. When you start a review, I'll add a 👀 emoji to each comment to let you know I've read it. I'll focus on feedback directed at me and will do my best to stay out of conversations between you and other bots or reviewers to keep the noise down. I'll push a commit with your requested changes shortly after. Please note there might be a delay between these steps, but rest assured I'm on the job! For more direct control, you can switch me to Reactive Mode. When this mode is on, I will only act on comments where you specifically mention me with New to Jules? Learn more at jules.google/docs. For security, I will only act on instructions from the user who triggered this task. |
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request adds comprehensive English and Chinese documentation, a JSON schema, and verification scripts for the mkdocs-document-dates plugin, alongside a legacy setup.py script. The review feedback highlights critical alignment issues between setup.py and pyproject.toml regarding dependencies and Python version requirements. Additionally, it identifies a bug in the Playwright verification script that masks failures in CI/CD pipelines, and points out broken anchor links in the English documentation due to uppercase headers.
Important
The consumer version of Gemini Code Assist on GitHub is being sunset. Starting June 18, 2026, new organization installations will be blocked, and all code review activity will officially cease on July 17, 2026.
For more details on the timeline and next steps, please review the Help Documentation.
| install_requires=[ | ||
| "mkdocs>=1.6,<=1.6.1", | ||
| "properdocs>=1.6.5", | ||
| "babel>=2.16" | ||
| ], |
There was a problem hiding this comment.
There is a significant discrepancy between the dependencies specified in setup.py and pyproject.toml:
pyyaml>=6.0is required by the plugin (imported inplugin.py) and listed inpyproject.toml, but is completely missing fromsetup.py'sinstall_requires.properdocsis listed as a required dependency insetup.py, but is only an optional (docs) dependency inpyproject.toml.mkdocsis restricted to<=1.6.1insetup.py, but allowed up to<2inpyproject.toml.
Please align the dependencies in setup.py with those in pyproject.toml to ensure consistent installation environments and prevent runtime ImportErrors.
| install_requires=[ | |
| "mkdocs>=1.6,<=1.6.1", | |
| "properdocs>=1.6.5", | |
| "babel>=2.16" | |
| ], | |
| install_requires=[ | |
| "mkdocs>=1.6,<2", | |
| "pyyaml>=6.0", | |
| "babel>=2.16" | |
| ], |
| "static/config/*" | ||
| ], | ||
| }, | ||
| python_requires=">=3.7", |
There was a problem hiding this comment.
There is a discrepancy in the minimum Python version requirement: pyproject.toml specifies requires-python = ">=3.9", while setup.py specifies python_requires=">=3.7".
Please align setup.py to require >=3.9 to match pyproject.toml and prevent installation on unsupported Python versions.
| python_requires=">=3.7", | |
| python_requires=">=3.9", |
| except Exception as e: | ||
| print(f"Error: {e}") |
There was a problem hiding this comment.
The script catches all exceptions, prints them, and then exits normally (with exit code 0). In CI/CD pipelines or automated verification steps, this will cause the step to report success even if the verification failed.
Please re-raise the exception in the except block so that failures are correctly detected by automated workflows.
| except Exception as e: | |
| print(f"Error: {e}") | |
| except Exception as e: | |
| print(f"Error: {e}") | |
| raise |
|
|
||
| #### Customization | ||
|
|
||
| Customizable via `avatar` field in [Enhanced author configuration](#Enhanced-author-configuration) (supports URL paths and local file paths). |
There was a problem hiding this comment.
The anchor link [Enhanced author configuration](#Enhanced-author-configuration) uses uppercase letters. Standard Markdown parsers (including Python-Markdown used by MkDocs) slugify headers to lowercase (e.g., #enhanced-author-configuration). This will result in a broken link when rendered.
Please update the anchor to lowercase.
| Customizable via `avatar` field in [Enhanced author configuration](#Enhanced-author-configuration) (supports URL paths and local file paths). | |
| Customizable via `avatar` field in [Enhanced author configuration](#enhanced-author-configuration) (supports URL paths and local file paths). |
| ... | ||
| ``` | ||
|
|
||
| Refer to [Reading Time Estimation](#Reading-Time-Estimation) for reading time calculation rules. |
There was a problem hiding this comment.
The anchor link [Reading Time Estimation](#Reading-Time-Estimation) uses uppercase letters. Standard Markdown parsers slugify headers to lowercase (e.g., #reading-time-estimation). This will result in a broken link when rendered.
Please update the anchor to lowercase.
| Refer to [Reading Time Estimation](#Reading-Time-Estimation) for reading time calculation rules. | |
| Refer to [Reading Time Estimation](#reading-time-estimation) for reading time calculation rules. |
PR Summary by QodoMerge upstream v3.8.7 and reorganize multilingual documentation
AI Description
Diagram
High-Level Assessment
Files changed (10)
|
Code Review by Qodo
1.
|
![qodo-code-review[bot]](https://avatars.githubusercontent.com/in/484649?s=60&v=4){kind=small}
| <p align="center"> | ||
| English | <a href="document-dates-zh.html">简体中文</a> | ||
| </p> |
There was a problem hiding this comment.
2. Brittle .html language links 🐞 Bug ⚙ Maintainability
The new bilingual docs hardcode cross-language links to document-dates-*.html, while the site nav and sources are .md. This is fragile across different URL output modes and can produce broken cross-language navigation in the generated site.
Agent Prompt
## Issue description
Docs pages hardcode `.html` cross-language links, which can break depending on the site’s URL mode.
## Issue Context
The nav is configured with markdown sources, so it’s safer to link using markdown-to-markdown links that the site builder can rewrite.
## Fix Focus Areas
- docs/document-dates-en.md[7-9]
- docs/document-dates-zh.md[7-9]
### What to change
- Replace the raw HTML `.html` links with markdown links to the `.md` pages, e.g.:
- In `document-dates-en.md`: `English | [简体中文](document-dates-zh.md)`
- In `document-dates-zh.md`: `[English](document-dates-en.md) | 简体中文`
- Alternatively, use site-relative links consistent with your chosen URL mode, but avoid hardcoding `.html` unless the build is explicitly configured to output flat `.html` files.
ⓘ Copy this prompt and use it to remediate the issue with your preferred AI generation tools
1 participant
This PR merges the latest changes from the upstream repository jaywhj/mkdocs-document-dates into our branch. It resolves several merge conflicts in the core logic and project configuration while ensuring our custom improvements (like timezone normalization and HTML escaping) are preserved. Additionally, it synchronizes the documentation assets and files from upstream and organizes them into a multi-language setup with a landing page, avoiding direct conflicts in the future.
PR created automatically by Jules for task 12394254122672464635 started by @RainPPR
Summary by cubic
Merged upstream v3.8.7 of
mkdocs-document-dates, added bilingual docs with a language landing page, and kept our timezone normalization and HTML escaping. Also removed legacy tooling and updated themkdocspin.New Features
docs/index.md); nav updated inproperdocs.yml.docs/assets/*and fixed README image paths.docs/schema.jsonfor config schema/validation.Dependencies
mkdocsto>=1.6,<2.setup.py(usepyproject.tomlonly).verify_docs.pyPlaywright smoke test.Written for commit fc3f621. Summary will update on new commits.