Make it public? about seaography HOT 9 CLOSED

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.

from seaography.

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.

from seaography.

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.

from seaography.

Agreed.

from seaography.

I started working on the documentation. Here you can see the pull request SeaQL/seaql.github.io#41

from seaography.

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

from seaography.

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.

from seaography.

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 seaography core & API

from seaography.

It's now public

from seaography.