docs: migrate 16 README files to a single NRG template#932
Open
andriishin wants to merge 1 commit intofilecxx:mainfrom
Open
docs: migrate 16 README files to a single NRG template#932andriishin wants to merge 1 commit intofilecxx:mainfrom
andriishin wants to merge 1 commit intofilecxx:mainfrom
Conversation
andriishin
force-pushed
the
nrg-migration
branch
from
717ecac to
5f69ecc
Compare
Replaces 16 hand-maintained READMEs (en + ar/de/es/fa/fr/hi/it/ja/ ko/pt-BR/ru/sv/tr-TR/zh-CN/zh-TW) with a single README.src.md, regenerated in CI by nanolaba/nrg-action@v1 on push to main. All 16 outputs are byte-identical to the originals (modulo a 2-line auto-generated header NRG injects at the top). Drift-check job runs in mode: check on PRs that touch any README*.md or the template, failing the build with a unified diff when a contributor edits a generated file directly.
andriishin
force-pushed
the
nrg-migration
branch
from
5f69ecc to
9a3f5d8
Compare
This was referenced Apr 28, 2026
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
1 participant
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.
Why
README.mdand 15 translations (README.ar.md,README.de.md,README.es.md,README.fa.md,README.fr.md,README.hi.md,README.it.md,README.ja.md,README.ko.md,README.pt-BR.md,README.ru.md,README.sv.md,README.tr-TR.md,README.zh-CN.md,README.zh-TW.md) are hand-maintained side-by-side. With 16 files in lockstep, every README change means editing the same paragraph in 16 places — a real maintenance burden as the project grows.This PR migrates all sixteen files to a single source-of-truth template using Nanolaba Readme Generator (NRG). Combined with
nanolaba/nrg-action@v1, regeneration happens in CI on every push tomain— no toolchain locally, just YAML.What changes
README.src.md— the unified source. Each line is tagged with<!--<lang>-->so it appears only in that language's output. Generated programmatically; outputs are byte-identical to today's files (modulo a 2-line auto-generated header)..github/workflows/nrg.yml— runsnanolaba/nrg-action@v1(pinned to NRG1.1):maintouchingREADME.src.mdor workflow → regenerates and auto-commits.README*.mdor template → drift check (mode: check) — fails with unified diff when a contributor edits a generated file directly.Verification
Locally, regenerating with NRG
1.1from Maven Central against currentmain(commit 770b2a8) produces output that diffs against the originals only by the 2-line auto-generated header. Zero functional content change.What's intentionally NOT in this PR
README.src.md. Future PRs can extract shared structural elements (badges, language nav strip, image references) into shared regions of the template.How to regenerate locally
About NRG
com.nanolaba:readme-generator— open-source, Apache 2.0, Java 8+. Ships as CLI, Maven plugin, GitHub Action, and library. Zero local toolchain needed when used through the action.