py-why
Documentation
I would like to begin documentation of this project. Please let me know if there are any areas that would be best to start from.
Hi @PraharshitaK-IS, @nstepka,
Wonderful! It would be great to get your assistance on documentation. I think right we are missing even the very basics for this project. Where would you like to begin? Perhaps a basic README or getting started?
@emrekiciman I'd like to start with the "Getting Started" Installation instructions.
That sounds great, @PraharshitaK-IS . Do you want to propose an outline for a getting started document, or feel free to just start writing based on the Getting Started documents of similar projects?
Either way, don't hesitate to reach out with questions. I know we have a lot of rough edges in the project, and as you prepare a getting started doc, we'll also have to fix issues in the library as they crop up.
As you create drafts, I'd recommend adding them to a fork or branch of pywhy-llm focused on these documentation improvements.
thank you so much!
Looks like the installation has a problem. Will unblock by working on https://github.com/py-why/pywhy-llm/issues/16 first.
- Then will start with the research paper this is based on to understand the concept and logic.
- Will go about documenting each interface for prompts, modeller and identifier.
I am new to python packaging, so this might take some time @emrekiciman. Will need help with checking if terminology and understanding are accurate and appropriate after the documentation is ready.
@emrekiciman Do you suggest going with a documentation manager like Docusaurus or should I use Sphinx - https://www.sphinx-doc.org/en/master/ to be uniform with the DoWhy documentation? Or will ReadMes suffice for the first draft?
Is there an alternate communication channel I can use to get in touch more frequently?