search

BjornFJohansson / pydna

Clone with Python! Data structures for double stranded DNA & simulation of homologous recombination, Gibson assembly, cut & paste cloning.
Other
166 stars 45 forks source link

Review notebook documentation #260

Closed manulera closed 1 month ago

manulera commented 2 months ago

Soon we will have some jupyter notebooks with documentation on how to get started with pydna (from issue https://github.com/BjornFJohansson/pydna/issues/244).

A task for the hackathon could be to go through this documentation and check if there are missing things, something could be added, there are errors, etc. Several people could review.

BjornFJohansson commented 2 months ago

I would love to do this. Are the notebooks available somewhere?

manulera commented 2 months ago

HI @BjornFJohansson I put a link to the notebooks in last call's notes. Here is the link:

https://github.com/JeffXiePL/pydna/tree/docs_peilun/docs/notebooks

These are in @JeffXiePL's fork in a branch called docs_peilun. He still wants to make some final touches to them before making a PR. I think we can wait for that before reviewing

JeffXiePL commented 2 months ago

Hi Manu and Bjorn:

I've finished with a draft of the documentations. Please feel free to review whenever. Two things are still missing, which I could not get right: 1) example for the Gibson Assembly, which I describe in more detail at this issue. 2) cripsr page.

Thank you, Manu and Bjorn, for your help and answering my questions!

manulera commented 2 months ago

Great, I can have a look at it tomorrow!

manulera commented 1 month ago

These will now be merged into dev_bjorn since the fork also had some small bug fixes. You can review them there at docs/notebooks.

JeffXiePL commented 1 month ago

For anyone reading/reviewing the documentations, just a note that there are some minor to-dos left, but the bulk of the documentation is complete. Please feel free to use/update the documentations.