-
-
Notifications
You must be signed in to change notification settings - Fork 36
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
Make it public? #20
Comments
That's an amazing idea. Currently I am working on some unit and integration tests. After that we can prioritize #18 so we can publish it ASAP. |
Agreed. |
I also think that the first public release should be accompanied by a nice article in the SeaORM blog and a report to https://this-week-in-rust.org. |
I started working on the documentation. Here you can see the pull request SeaQL/seaql.github.io#41 |
I'd say "full documentation" like SeaQL/seaql.github.io#41 is good to have but not a must at this stage given that the API is far from stable. I think source code documentation is good enough at this stage. Also, we should spend most of the time and focus on development & design of |
My experience of working with open source projects always on the edges teaches me that a minimum of documentation (even if not stable) guarantees a faster use by many people AND THEREFORE useful PR and ISSUES. For this I took the liberty of recommending it. And in any case, much of that documentation had to be written sooner or later. |
Hey @frederikhors, I agree and no doubt that documentation is essential to developer adoption. But I strongly believe software (engineering) and functionality should come first :D |
Made a draft for the documentation here SeaQL/seaql.github.io#41 I am open for feedback about information you desire to be discussed in the documentation. |
It's now public |
You are doing a wonderful job! Congratulations to all!
I think after an initial but comprehensive documentation this project could be made public so as to receive feedback, PRs and more from Rust lovers so as to proceed even faster.
What do you think?
I could help write some docs but I'm still stuck with projects and haven't started using this yet.
The text was updated successfully, but these errors were encountered: