Skip to content

docs(441): document language-file provenance refresh/preserve behaviour - #86

Open
wisdommen wants to merge 1 commit into
alphafrom
docs/phase-16-language-files
Open

docs(441): document language-file provenance refresh/preserve behaviour#86
wisdommen wants to merge 1 commit into
alphafrom
docs/phase-16-language-files

Conversation

@wisdommen

Copy link
Copy Markdown
Member

Targets alpha deliberately -- this documents unreleased 6.3.0 behaviour, not the currently
released master layer. Companion framework PR: UltiKits/UltiTools-Reborn#458 (also alpha).

What changed

Bilingual i18n.md (en + zh) gains one new section, "Provenance-based file refresh", explaining
the language-file provenance mechanism landing alongside #441:

  • An untouched lang/<code><ext> file is silently replaced by the current jar's bundled copy on
    the module's next start, with one INFO line naming the file.
  • A file you have customised is never overwritten. Only the individual keys whose String.format
    placeholder count (%s/%d, or an explicit %1$s index) has moved between your file and the
    current jar are resolved from the jar instead, with a WARN naming the module, file and key.
  • How to force a refresh of a customised file: delete it and restart the module.

Marked "as of v6.3.0". No new <<< @/../examples/... reference, no versionsConfig.current /
examples/pom.xml version bump.

Verification

  • npm run build succeeds.
  • bash scripts/check-container-length.sh docs/src/guide/essentials/i18n.md docs/src/zh/guide/essentials/i18n.md -- 0 violations.
  • Heading count matches between the English and Chinese pages (6 and 6).
  • CRLF preserved on both files (file(1)/line-ending check before and after editing).

🤖 Generated with Claude Code

https://claude.ai/code/session_018BUB3sHMAHm8bYVbLbTTKK

…reserve behaviour

- Bilingual (en/zh) i18n.md page: a new Provenance-based file refresh section
  explaining the four cases -- an untouched file is silently replaced by the
  current jar's copy with one INFO line; a customised file is left alone, with
  only individual keys whose String.format placeholder count moved resolved
  from the jar (a WARN naming module/file/key); and how an operator forces a
  refresh (delete the file, restart, framework re-extracts and re-baselines).
- Marked v6.3.0. Prose and inline code only, no new compiled-example reference,
  no versionsConfig.current change. npm run build succeeds; container-length
  check reports 0 violations on both changed files.

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_018BUB3sHMAHm8bYVbLbTTKK
@chatgpt-codex-connector

chatgpt-codex-connector Bot commented Sep 13, 2026

Copy link
Copy Markdown

Codex Review Summary

This comment shows the latest Codex review activity on this pull request.

Review Status Commit Review trigger
📝 Code Review Completed 2026-09-13T12:24:48.164295Z 6f8b315 PR opened
ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review" or "@codex security review".

Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings.

@cloudflare-workers-and-pages

Copy link
Copy Markdown

Deploying ultitools-dev-doc with  Cloudflare Pages  Cloudflare Pages

Latest commit: 6f8b315
Status: ✅  Deploy successful!
Preview URL: https://2179744a.ultitools-dev-doc.pages.dev
Branch Preview URL: https://docs-phase-16-language-files.ultitools-dev-doc.pages.dev

View logs

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 6f8b315d9a

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

leaves your file alone. Only the individual keys whose `String.format` placeholder count
(`%s`, `%d`, or an explicit `%1$s` index) has changed between your file and the current jar
are resolved from the jar instead, each logged once as a WARN naming the module, file and key
-- your other keys keep your wording.

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge Replace the pause dash with a direct sentence

The newly added -- creates a pause before a supplemental clause, contrary to the English-locale writing rule. End the WARN sentence before explaining that the remaining keys retain their wording, or connect the clauses directly with “while.”

AGENTS.md reference: AGENTS.md:L27-L31

Useful? React with 👍 / 👎.

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.

1 participant