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

Reorganize the README files, move them from the root folder to docs sub-folder #2210

Closed
marcomarchesi opened this issue Jan 12, 2025 · 3 comments
Labels
enhancement New feature or request

Comments

@marcomarchesi
Copy link

marcomarchesi commented Jan 12, 2025

Hi everyone, I finally started looking at Eliza code as I would love to contribute as much as I can.

First thing I noticed is that all the README files in various languages are in the root folder, making an unnecessary long scrolling. Also the files are not consistent each other, they contain different documentation. From a first overview it looks a bit confusing.

I would suggest to move all the README files (except the EN one) into a subfolder readme or under docs, with each one still linked in the root README, to make the root folder cleaner.

About the consistency, I still need to see how documents are generated but AI-based translation (by an Eliza agent?) could be a good option, unless you already encountered issues on having that.

@marcomarchesi marcomarchesi added the enhancement New feature or request label Jan 12, 2025
Copy link
Contributor

Hello @marcomarchesi! Welcome to the ai16z community. Thank you for opening your first issue; we appreciate your contribution. You are now a ai16z contributor!

@tcm390
Copy link
Collaborator

tcm390 commented Jan 12, 2025

related: #2149

@marcomarchesi
Copy link
Author

nice, it didn't come up from my first search, thank you!

@tcm390 tcm390 reopened this Jan 12, 2025
@tcm390 tcm390 closed this as completed Jan 18, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants