search

iceberg-project / ICEBERG-middleware

This repo contains the ICEBERG middleware as it is agreed by the members of the ICEBERG project.
MIT License
2 stars 1 forks source link

Update wiki page #15

Open iparask opened 5 years ago

iparask commented 5 years ago

Do you believe we needs a readthedocs style documentation for ICEBERG?

hlynch commented 5 years ago

I'm not familiar with what you have in mind. Can you point to an example? (Normally, I don't weigh in on thew CI stuff but the documentation has to be human-readable so I'm keen to make sure its sufficient.)

On Fri, Aug 30, 2019 at 9:31 AM Ioannis Paraskevakos < notifications@github.com> wrote:

Do you believe we needs a readthedocs style documentation for ICEBERG?

— You are receiving this because you are subscribed to this thread. Reply to this email directly, view it on GitHub https://github.com/iceberg-project/ICEBERG-middleware/issues/15?email_source=notifications&email_token=ABGZI6MQOBZFJADHNEQGOP3QHEOLRA5CNFSM4ISNLRGKYY3PNVWWK3TUL52HS4DFUVEXG43VMWVGG33NNVSW45C7NFSM4HIOOCIQ, or mute the thread https://github.com/notifications/unsubscribe-auth/ABGZI6OTIKHIZHA5C3RUZLDQHEOLRANCNFSM4ISNLRGA .

-- Dr. Heather J. Lynch Associate Professor of Ecology & Evolution Stony Brook University 113 Life Sciences Bldg. Stony Brook, NY 11794 Phone: 631-632-9508 Web: lynchlab.com

bspitzbart commented 5 years ago

@hlynch :Here is an example https://radicalpilot.readthedocs.io/en/latest/ A readthedocs would be very helpful AFTER plain, step by step documentation is done for users.

iparask commented 5 years ago

And it can be incremental as we add features and such.

iparask commented 4 years ago
bspitzbart commented 4 years ago

This includes project READMEs and notebooks.