fix(docs): repair zh-cn 15.8 markup, and run the lint that was added but never ran - #467
Merged
Conversation
…n LLM guides Inline markup cannot open against a CJK character, so `实现其**AI搜索模式` was never read as strong emphasis: the asterisks stayed in the text and reached the rendered page and its meta description. The 15.7 copies of these three pages were repaired in #465; these are their 15.8 counterparts, which were left out at the time to avoid colliding with work in progress. The same escaped space this repository already uses for CJK-adjacent markup is applied here. zh-cn/15.8/config/rank-fusion.rst carries the same defect and is deliberately not touched: it is already repaired on the branch that rewrites the 15.8 semantic search guides, and fixing it here would only conflict with that. 15.8 is not published yet, so this changes nothing that is live today -- it keeps the defect from shipping with the release.
This repository had no CI. tools/check_headings.py was added in #465 to stop a defect class from coming back -- a section title whose overline and underline differ is silently dropped by docutils, and the next section becomes the page title without anything failing -- but nothing ran it, so it could only catch what someone remembered to check by hand. The same was true of tools/test_update_eol.py. Two jobs, no dependencies beyond the standard library: - tools: the unit tests, and `update_eol.py --check`, which fails when an eol.rst has drifted from versions.json. Its date warnings are reported without failing the build, so time passing cannot turn the build red on its own. - section titles: the heading lint over the versions versions.json calls current. Reading the version from versions.json means a release moves the scope by itself instead of needing an edit here, and it keeps the archived versions -- which still carry mismatches and are consolidated by canonical anyway -- from blocking unrelated work. Verified: green on the current tree, and red with the expected one-line report when a heading rule is shortened by a single character.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Two follow-ups to #465.
Bold text that never opened, in the zh-cn 15.8 LLM guides
Inline markup cannot open against a CJK character, so
实现其**AI搜索模式was never read as strong emphasis. The asterisks stayed in the text and reached the rendered page and itsmeta description.The 15.7 copies of these three pages were repaired in #465. These are their 15.8 counterparts, left out at the time to avoid colliding with work in progress, and fixed here with the same escaped space this repository already uses for CJK-adjacent markup.
zh-cn/15.8/config/rank-fusion.rstcarries the same defect and is deliberately not touched — it is already repaired on the branch that rewrites the 15.8 semantic search guides, and changing it here would only conflict with that.15.8 is not published yet, so nothing live changes. This keeps the defect from shipping with the release.
CI
This repository had no CI at all.
tools/check_headings.pywas added in #465 to stop a defect class from coming back — a section title whose overline and underline differ is dropped by docutils, and the next section silently becomes the page title without anything failing the build — but nothing ran it, so it could only catch what someone remembered to check by hand. The same was true oftools/test_update_eol.py.Two jobs, nothing beyond the standard library:
update_eol.py --check, which fails when aneol.rsthas drifted fromversions.json. Its date warnings are reported without failing the build, so time passing cannot turn the build red on its own.versions.jsoncalls current. Reading the version fromversions.jsonmeans a release moves the scope by itself instead of needing an edit here, and it keeps the archived versions, which still carry mismatches and are consolidated by canonical anyway, from blocking unrelated work.Verified green on the current tree, and red with the expected one-line report when a heading rule is shortened by a single character.
Noted, not changed here
update_eol.pyreports that 14.19 reached end of life on 2026-08-01 whileversions.jsonstill lists it as supported. Whether a version is still supported is a decision recorded inversions.json, not something a tool should infer, so it is left for the maintainer.