Re: Request for confirmation on RTL translation structure for Introduction page

[email protected] (Jordi Kroon) Mon, 8 Jun 2026 20:31:16 +0200
Newsgroups php.doc,php.doc
Message-ID <[email protected]>
On 08/06/2026 3:09 pm, MOSTAFA SHARIATZADEH wrote:
> my github:
> https://github.com/m-shariatzadeh/doc-fa <https://github.com/m- 
> shariatzadeh/doc-fa>
> 
> ‫‪MOSTAFA SHARIATZADEH‬‏ <‪[email protected] 
> <mailto:[email protected]>‬‏> در تاریخ دوشنبه ۸ ژوئن ۲۰۲۶ ساعت ۱۶:۳۸ 
> نوشت:‬
> 
>     Hello PHP Documentation Team,
> 
>     I have completed the translation of the “Introduction” page into
>     Persian (Farsi).
> 
>     Before proceeding with translating the rest of the documentation, I
>     would appreciate a quick confirmation that the current structure and
>     format of the translation are acceptable from your side.
> 
>     Since the content is in a right-to-left language, I have adapted the
>     text accordingly to ensure proper display of both Persian and
>     embedded English terms within the page. I want to make sure that
>     this RTL layout does not cause any rendering or formatting issues on
>     the PHP documentation website.
> 
>     This is purely a request for confirmation so I can continue
>     translating the remaining sections with confidence that the approach
>     is correct.
> 
>     Thank you for your time and support.
> 
>     Best regards,
> 
>     Mostafa
> 
>     ------------------------------------------------------------------------
> 

Hi Mustafa,

The current structure (for what I can judge) seems fine. Though a few 
notes I would like to point out to help you get started. I do not now if 
there will be any issues regarding RTL, but I think it shoul be fine. If 
not, please open an issue in https://github.com/php/phd.

At the start of each file you will see a revision. [1] & [2]
Every translated file will have one, and it is used to keep track of the 
status of each document. Not just if it is translated, but also if it is 
up-to-date. You can generate the hash through `git log`. Which you can 
read more about in the translation guide. [3]

Files that are not translated, should *not* exist in the translation 
repo. So the important thing to do is, when you translated. Add them. 
Otherwise leave them out of the repo. Which will make it easier for you 
to manage the repo. But it will also allow the for an automatic fallback 
to english for non translated files. For that you can look at the 
structure guide [4].

When you get to a point where the most relevant files have been 
translated, you can write to the mailing list again. It will then allow 
the repo to be moved into the PHP Organization, included in the manual 
as active translation.

For now I would like to thank you for your interest in translating the 
docs. If you have any further questions, feel free to ask here over the 
mailing list. There is also a Discord channel dedicated to docs in the 
PHP Community [5].

References:
[1] https://github.com/php/doc-fr/blob/master/chapters/intro.xml#L2
[2] 
https://github.com/m-shariatzadeh/doc-fa/blob/abff24f238d2c1c9483fe197e211e2c738e2c62d/chapters/intro.xml#L2
[3] https://doc.php.net/guide/translating.md
[4] https://doc.php.net/guide/structure.md
[5] https://discord.com/channels/356354025865740288/970787522718355456

-- 
Regards,

Jordi Kroon