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

Can code be more documented? #64

Open
raul-guerrero opened this issue Mar 23, 2021 · 4 comments
Open

Can code be more documented? #64

raul-guerrero opened this issue Mar 23, 2021 · 4 comments

Comments

@raul-guerrero
Copy link

raul-guerrero commented Mar 23, 2021

Hi,

I'm very curious about the overall design and implementation of Lithium, but getting my head around it is getting quite difficult, how come there are barely any code comments or some sort of naming patterns to make it a bit more readable?

Also, is there some overall bird's eye view design somewhere?

Wouldn't improving that also improve other people contributing?

cheers

@matt-42
Copy link
Owner

matt-42 commented Mar 23, 2021

Definitely something I must improve to make life easier to new lithium contributors. I'll do my best to have this done in April.

@raul-guerrero
Copy link
Author

@matt-42 is there something I can help with to help you get started? on my current day job I'm an architect, so I'm used to writing documentation, doing diagrams, etc.
If you have anything you can share, I can contribute with some of that :)
If you want, we can put that in the Github wiki

@matt-42
Copy link
Owner

matt-42 commented Mar 31, 2021

Thanks ! I´ll send you some drafts when ready.

@gtustus123
Copy link

Dear Matt, would you be so kind to give more documents or example codes for lithium. What do you think, may I use it in a production environment, handling millions of mysql queries over the web? Thanks.

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

No branches or pull requests

3 participants