docs: migrate 4 README files to a single NRG template#654
Open
andriishin wants to merge 1 commit into
Open
Conversation
|
andriishin
force-pushed
the
nrg-migration
branch
from
April 28, 2026 06:42
acf2bf1 to
7403f17
Compare
Replaces 4 hand-maintained READMEs (en + it/jp/zh) with a single README.src.md, regenerated in CI by nanolaba/nrg-action@v1 on push to master. All 4 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
April 28, 2026 07:39
7403f17 to
2669d1d
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.md,README.it.md,README.jp.md,README.zh.mdare hand-maintained side-by-side. Every README change means editing the same paragraph in 4 places — easy to miss one and let drift creep in.This PR migrates all four 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 tomaster— 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 from the existing four files; 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):mastertouchingREADME.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 currentmasterproduces 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 into shared regions of the template.How to regenerate locally
```bash
curl -L -o nrg.jar https://repo1.maven.org/maven2/com/nanolaba/readme-generator/1.1/readme-generator-1.1.jar
java -jar nrg.jar -f README.src.md
```
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.