Xapiand icon indicating copy to clipboard operation
Xapiand copied to clipboard

Documentation Status

Open lodestone opened this issue 6 years ago • 4 comments

I've been through the existing documentation and found several places that need to be finished. Is there a plan for the documentation? And is there any way I can help?

lodestone avatar Jun 02 '18 06:06 lodestone

Hi @lodestone, absolutely, we need a lot of help right now. Xapiand supports a whole bunch of things that aren't listed in the current docs.

The plan would be to try to fill in the blanks there in the docs pages. We are basing the structure on Elasticsearch docs, but we want to extend by adding functionality specific to Xapiand and make things as simple as possible.

On every such page, there's an "Improve this page" link at the top which you can use to make pull requests.

Kronuz avatar Jun 02 '18 12:06 Kronuz

I would love to help document but my C/C++ is weak. I would likely need an intrusive amount of time answering questions to be of any value to a documentation effort. That said, I'm still going to be poking around the code to see what I can figure out.

lodestone avatar Jun 02 '18 20:06 lodestone

Hey @Kronuz - I finally made my first PR on the docs!

And great work lately on this project! It is exciting to see the activity! 😄

lodestone avatar Feb 15 '19 06:02 lodestone

Documentation has been making major leaps over the last weeks, it’s still nowhere near complete, but it’s getting there

Kronuz avatar Mar 24 '19 20:03 Kronuz