Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Restructuration readme FR #569

Merged
merged 14 commits into from
Feb 10, 2025
Merged

Restructuration readme FR #569

merged 14 commits into from
Feb 10, 2025

Conversation

MivraMe
Copy link
Contributor

@MivraMe MivraMe commented Feb 5, 2025

Restructuration du readme FR ce qui facilite la lecture et la compréhension pour les futurs installations.

  • Supprimer info.md
  • Retirer certaines informations que je crois désuet

Dites moi ce que vous en pensez, je vais pouvoir ensuite traduire la version final en anglais.

@RayLation
Copy link

J'ai checké ben vite et ca m'a l'air très clean et plus visuellement agréable!
Seule chose que j'ajouterais peut-etre, c'est des sections "collapsables". Ca ferait un wall of text moins intimidant.

[]https://gist.github.com/pierrejoubert73/902cc94d79424356a8d20be2b382e1ab

@louim
Copy link
Contributor

louim commented Feb 5, 2025

Rendered version. My two cents is that we might want at some point to break down the readme in two. The main readme would keep the "what does Hilo do and how to use it". I would move everything technical and dev related to a separate file. Maybe DEV.md or CONTRIBUTING.md?

That way, users that only want to use Hilo would find info easily, and other that want to get into the nitty gritty details or contribute could go to the second file.

@MivraMe
Copy link
Contributor Author

MivraMe commented Feb 5, 2025

Rendered version. My two cents is that we might want at some point to break down the readme in two. The main readme would keep the "what does Hilo do and how to use it". I would move everything technical and dev related to a separate file. Maybe DEV.md or CONTRIBUTING.md?

That way, users that only want to use Hilo would find info easily, and other that want to get into the nitty gritty details or contribute could go to the second file.

Great idea! With that we can also add more information about dev and contribution without encroaching in the main readme. !

I will modify it.

@MivraMe
Copy link
Contributor Author

MivraMe commented Feb 5, 2025

Update, merci pour vos commentaires.

  • Déplacer la section contribution dans son propre fichier

@RayLation, Sur quels éléments pense-tu qu'il serait approprié d'utiliser des sections collapse ?

@ic-dev21
Copy link
Collaborator

ic-dev21 commented Feb 6, 2025

Je passerai une shot de pre-commit dessus après, keep it up!

@ic-dev21 ic-dev21 merged commit 2d9490c into dvd-dev:main Feb 10, 2025
3 checks passed
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.

4 participants