github pages documentation

codingchili / chili-core

Reactive framework for creating transport & storage-transparent microservices with Vert.x

https://codingchili.github.io/chili-core/

MIT License

14 stars 5 forks source link

github pages documentation #240

Open codingchili opened 5 years ago

codingchili commented 5 years ago

[x] create a github page with documentation
[ ] create one chapter for each submodule/package.
[x] publish javadoc somewhere.

codingchili commented 5 years ago

Javadoc is published on the github page, but there are some issues with rendering class-level javadoc titles.

This may be caused by by the @Author tag being the first line in the javadoc, or a

tag preceding the first line.

work in progress: https://codingchili.github.io/chili-core/

codingchili commented 5 years ago

Added package-level javadoc.

Fixed an issue with class-level javadoc not being rendered due to the @Author tag being declared before the summary body. Removed the @Author tag completely.

codingchili commented 5 years ago

[x] link to vertx docs from index.md
[x] link to hazelcast docs from index.md

codingchili commented 5 years ago

Design decisions needs to be documented, also add a vision.

codingchili commented 5 years ago

Design decision: returning streams from AsyncStorage queries

Has been tried before, not feasible

accepting streams are a bit more work, most often we'll end up with terminating it into a collection directly.
maybe this could be improved by adding support to the serializer/Request::result

The major issues, performance

while the query/cursor is created in a blocking pool streaming (evaluating the stream, pulling new entries, moving the cursor) would actually happen on the event loop. This will block the event loop, milliseconds.