Comments (6)
Hey.
This is a great project!
I have used - Meilisearch previously - a similar project in Rust.
Bringing a similar project to Elixir, brings me delight.
I am willing to contribute to the docs. Can you point me where to start?
from ex_elasticlunr.
Great to hear! Happy that it's already underway. Again, really great project you have here (I did not see that you were the one who posted the issue, thought it was someone else - my apologies!).
from ex_elasticlunr.
@TwistingTwists I'm glad to have you contribute to the docs or any other part of the project. To get started, I will suggest you start by updating the documentation (including examples where applicable) for each module based on it behavior or logic contained in it. Do not hesitate to reach out (via email) in case you are unsure of what a module does or how it contributes to the project. Note that you will need to familiarize yourself with the internal workings of the library so as to help you write more informative documentation.
I hope my suggestion isn't vague, do let me know if you have a better approach that will get us going with the documentation.
Thank you for wanting to contribute to the project, I really appreciate it.
from ex_elasticlunr.
+1 on Docs, but also the code should be commented! I read/write in Elixir but some of it was a bit hard to follow (not too hard, but comments are always great!).
Using the @doc macro would aid in inline understanding (and future proofing) the code, and help with adding some quick and simple documentation.
Thanks for your work on this @heywhy will def be using this soon!
from ex_elasticlunr.
@drannex42 thank you for the feedback. your suggestion is what weβre working on already, module docs will be coming in before any other external docs.
Actually, the goal is to have an informational documentation on hexdocs.
from ex_elasticlunr.
No worries. I posted the issue myself to solicit for contributors to help.
from ex_elasticlunr.
Related Issues (8)
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
π Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. πππ
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google β€οΈ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from ex_elasticlunr.