Documentation improvements

man-group / arctic

High performance datastore for time series and tick data

https://arctic.readthedocs.io/en/latest/

GNU Lesser General Public License v2.1

3.06k stars 583 forks source link

Documentation improvements #681

Closed shashank88 closed 5 years ago

shashank88 commented 5 years ago

[x] Add label on top of README pointing to readthedocs.
[x] Point wiki to readthedocs and move over remaining documents in wiki to readthedocs.
[x] Add more documentation on tickstore
[x] Quickstart section in readthedocs.
[x] Some FAQs with commonly asked questions.
[x] Comparision section with real world use cases of VersionStore/TickStore/Chunkstore since this seems to be a pretty common question.
[x] Thread safety notes in FAQ
[x] Cleanup current doc on readthedocs

femtotrader commented 5 years ago

Maybe you can also add doc link also in Arctic repository description

bmoscon commented 5 years ago

I'd also add a checkbox for the API documentation, as this is something we really should do

shashank88 commented 5 years ago

@bmoscon if you get time, can you add some FAQs based on the most common things people asked with plain text or the issue link if you replied in the Github issue anyways to save pasting?

bmoscon commented 5 years ago

@shashank88 can do!

shashank88 commented 5 years ago

Thanks! This should be quite useful for me as well

shashank88 commented 5 years ago

Added all of the above to documentation. This is a never ending process, but I think I am happy for now. Some things I would like to add is a nice diagram for Version/ChunkStore that describes how the chunking / serialization / compression works on a top level.