hotosm / fAIr

AI Assisted Mapping
GNU Affero General Public License v3.0
69 stars 58 forks source link

Add detailed Github Wiki documentation #128

Open petya-kangalova opened 1 year ago

petya-kangalova commented 1 year ago

Add clear documentation about fAIr in the https://github.com/hotosm/fAIr/tree/master/docs including:

As discussed for @neelimagoogly to work on this week. Closing this one https://github.com/hotosm/fAIr/issues/113

omranlm commented 6 months ago

@petya-kangalova I think we have some FAQs now after some HUBs feedback, can we pick this up?

petya-kangalova commented 6 months ago

Yes! @omranlm I was actually thinking to update this md https://github.com/hotosm/fAIr/blob/master/docs/FAQ.md. Will also get the interns to support with updates next week @edenxcodes - we can ask them to create PRs to add FAQs that I can share.

@omranlm let's speak tomorrow as my main question is how we want to pull all these docs into fAIr frontend.

MissTipo commented 4 months ago

Please assign this issue to me

kshitijrajsharma commented 4 months ago

Go ahead ! MissTipo

KimFarida commented 4 months ago

Hello @kshitijrajsharma may i please take on this issue with @MissTipo

nwekealex65 commented 3 months ago

Hello @petya-kangalova you mentioned sharing FAQ which we can add to the https://github.com/hotosm/fAIr/blob/master/docs/FAQ.md, do you mind sharing it so I can work on it?

petya-kangalova commented 3 months ago

@nwekealex65 thank you! This task is not specific to the Outreachy contributor period. See document for FAQ here: https://github.com/hotosm/fAIr/issues/196

nwekealex65 commented 3 months ago

@petya-kangalova which of the task is open for the contributor period? the raw-data-api?

petya-kangalova commented 3 months ago

@nwekealex65 these are the two projects. Please read all the instructions on the site: https://www.outreachy.org/outreachy-june-2024-internship-round/communities/humanitarian-openstreetmap-team/

Here are the issues for contribution:

Create a Python-based mobile application to collect OpenStreetMap data in the field: https://github.com/hotosm/osm-fieldwork/issues/204

Create backend tests and API documentations fAIr : (https://github.com/hotosm/fAIr/issues/229) and Raw Data API (https://github.com/hotosm/raw-data-api/issues/219)

spwoodcock commented 3 months ago

@nwekealex65 these are the two projects. Please read all the instructions on the site: https://www.outreachy.org/outreachy-june-2024-internship-round/communities/humanitarian-openstreetmap-team/

Here are the issues for contribution:

Create a Python-based mobile application to collect OpenStreetMap data in the field: https://github.com/hotosm/osm-fieldwork/issues/43

Create backend tests and API documentations fAIr : (https://github.com/hotosm/fAIr/issues/229) and Raw Data API (https://github.com/hotosm/raw-data-api/issues/219)

It's issue https://github.com/hotosm/osm-fieldwork/issues/204 for osm-fieldwork, as 43 was the old task that was already complete 👍

petya-kangalova commented 3 months ago

Thanks @spwoodcock fixed! Apologies

princyym commented 3 months ago

Hello can i work on this can you assign me @petya-kangalova