Skip to content

Comments

Move readmes to subdir + tag them as generated.#19

Closed
orhtej2 wants to merge 2 commits intoYunoHost:mainfrom
orhtej2:move_readmes
Closed

Move readmes to subdir + tag them as generated.#19
orhtej2 wants to merge 2 commits intoYunoHost:mainfrom
orhtej2:move_readmes

Conversation

@orhtej2
Copy link
Contributor

@orhtej2 orhtej2 commented Feb 1, 2025

Example changes created (tool run locally + manual change to '.gitattributes' to prove the point), result here: https://github.com/YunoHost-Apps/anarchism_ynh/pull/23/files

Now repo has README.md in the root, localized versions + ALL_README.md land in doc/readme subdir to lower the clutter.

Files are marked as generated hence don't autoexpand in PRs.

@oleole39
Copy link
Contributor

oleole39 commented Mar 28, 2025

I agree the repo looks neater that way.
One additional idea: maybe remove ALL_README.md and add a line in each README (with current language in bold; also link to EN would then be at the directory root) such as :

🌐 EN | ES | EU | FR | GL | ID | NL | PL | RU | ZH

🌐 [EN] | [ES](doc/readme/README_es.md) | [EU](doc/readme/README_eu.md) | [FR](doc/readme/README_fr.md) | [GL](doc/readme/README_gl.md) | [ID](doc/readme/README_id.md) | [NL](doc/readme/README_nl.md) | [PL](doc/readme/README_pl.md) | [RU](doc/readme/README_ru.md) | [ZH](doc/readme/README_zh.md) 

Or:

Language: EN | ES | EU | FR | GL | ID | NL | PL | RU | ZH

**Language:** **EN** | [ES](doc/readme/README_es.md) | [EU](doc/readme/README_eu.md) | [FR](doc/readme/README_fr.md) | [GL](doc/readme/README_gl.md) | [ID](doc/readme/README_id.md) | [NL](doc/readme/README_nl.md) | [PL](doc/readme/README_pl.md) | [RU](doc/readme/README_ru.md) | [ZH](doc/readme/README_zh.md)

@orhtej2
Copy link
Contributor Author

orhtej2 commented Mar 28, 2025

@oleole39 there's #18 that focuses on actual README content, let's move this discussion there perhaps?

@orhtej2
Copy link
Contributor Author

orhtej2 commented Apr 2, 2025

Superseded by #18

@orhtej2 orhtej2 closed this Apr 2, 2025
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