Skip to content

docs: add Persian (fa-IR) README - #95

Merged
itsfatduck merged 1 commit into
itsfatduck:masterfrom
NimaHp:docs/persian-readme
Oct 13, 2026
Merged

itsfatduck merged 1 commit into
itsfatduck:masterfrom
NimaHp:docs/persian-readme

Conversation

@NimaHp

@NimaHp NimaHp commented Oct 11, 2026

Copy link
Copy Markdown
Contributor

Adds the Persian (fa-IR) README, in the same commit as its registration in the language switcher.

What

  • .github/readmes/README.fa-IR.md, a translation of the root README
  • **فارسی** appended to the switcher row in all 15 files, so the row stays symmetric: the root README plus every other locale lists this one, and none of them was touched beyond that one appended entry

Review of the incoming draft

The draft needed real cleanup before it was usable, so this is not just a copy:

  • 308 [span_N](start/end_span) citation markers left by the translator, removed
  • Blank lines had collapsed to 4 against 127 in the English file, which breaks lists, tables and callouts. The structure is now taken from README.md line for line
  • Paths were wrong for the new location. The draft was copied from the root README, so ./.github/assets/, ./CONTRIBUTING.md and ./LICENSE would all resolve to paths that do not exist from .github/readmes/. Assets are now ../assets/, root documents ../../, the CONTRIBUTING translations ../contributing/, and the switcher points at the sibling files with فارسی bolded and English linking back to ../../README.md. Every relative link and image resolves now.
  • Seven lines started with a Latin character, the product name or the language switcher, so the bidi algorithm laid those paragraphs out left to right inside a Persian document. Each carries a U+200F RIGHT-TO-LEFT MARK right before the first visible character, after the markdown syntax. Invisible, changes no link or heading.
  • One Arabic yeh inside a Persian word. The yeh and teh marbuta inside العربية are left alone, since that is the native name.
  • Terminology follows Translations.fa-IR.resx rather than transliteration: Copilot, PowerShell, Reflection, Hibernation, Prefetch, Registry, Task Manager, widgets as ابزارک‌ها, recycle bin as سطل بازیافتنی, scheduled tasks as وظایف زمان‌بندی‌شده, and the risk labels the app itself shows, امن / با احتیاط / تخصصی
  • سوالات to سؤالات, آپدیت to به‌روزرسانی, and a stray digit removed from the Discord banner alt text

Verification

  • 33 headings at matching levels against README.md, 83 links, same elements in the same order
  • All 15 READMEs resolve to the same 84 distinct targets
  • Zero lines left starting with a Latin character
  • No unresolved relative link or image in the new file

Worth noting separately

The GPL badge here points at ../assets/gplv3.png, which resolves. The 13 existing locale files keep .github/assets/gplv3.png, which does not resolve from .github/readmes/, so their licence badge is currently broken in this repository. That is a pre-existing bug and not touched here, since it is unrelated to this contribution.

Persian translation of the root README, placed in .github/readmes/ like every other locale, and registered in the language switcher of all 15 files so the row stays symmetric.

Review of the incoming draft before committing:

- dropped 308 [span_N](start/end_span) citation markers left by the translator
- restored the blank line structure from README.md; the draft had collapsed them to 4
  against 127 in the English file, which breaks lists, tables and callouts
- fixed the paths for the new location: assets become ../assets/, the repository
  root documents become ../../, the CONTRIBUTING translations ../contributing/,
  and the language switcher points at the sibling files with فارسی bolded and
  English linking back to ../../README.md. Every relative link and image in the
  file now resolves to a real path
- seven lines started with a Latin character, the product name or the language
  switcher, which made the bidi algorithm lay those paragraphs out left to right
  inside a Persian document. Each now carries a U+200F RIGHT-TO-LEFT MARK right
  before the first visible character, after the markdown syntax, so the paragraph
  direction is RTL. The character is invisible and changes no link or heading
- one Arabic yeh inside a Persian word; the yeh and teh marbuta in العربية stay,
  since that is the native name
- terminology aligned with Translations.fa-IR.resx rather than transliterated:
  Copilot, PowerShell, Reflection, Hibernation, Prefetch, Registry, Task Manager,
  widgets as ابزارک‌ها, recycle bin as سطل بازیافتنی, scheduled tasks as وظایف
  زمان‌بندی‌شده, and the risk labels the app shows: امن، با احتیاط، تخصصی
- سوالات to سؤالات, آپدیت to به‌روزرسانی, and the Discord banner alt text dropped
  the stray digit

The switcher change is a single appended entry per file, nothing else in those 14
files was touched.

Structure verified against README.md: 33 headings at matching levels, 83 links,
the same elements in the same order, and all 15 files resolve to the same 84
distinct targets.

One difference worth noting: the GPL badge here points at ../assets/gplv3.png, which
resolves. The existing locale files keep .github/assets/gplv3.png, which does not
resolve from .github/readmes/, so their licence badge is currently broken. Fixing
those is a separate change and not touched here.
@NimaHp
NimaHp requested a review from itsfatduck as a code owner October 11, 2026 17:03

@itsfatduck itsfatduck left a comment

Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

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

Nice! Thank you for contributing Persian README locale!

@itsfatduck
itsfatduck merged commit b82effe into itsfatduck:master Oct 13, 2026
1 check passed
@NimaHp
NimaHp deleted the docs/persian-readme branch October 14, 2026 12:23
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.

2 participants