sotopia-lab / sotopia

Sotopia: an Open-ended Social Learning Environment (ICLR 2024 spotlight)
https://docs.sotopia.world
MIT License
127 stars 16 forks source link

[FEAT]: update contribution readme and sync with docs webpage #85

Open XuhuiZhou opened 1 month ago

XuhuiZhou commented 1 month ago

Description

Additional Information

No response

ProKil commented 1 month ago

I would suggest we

  1. add a contribution page in the doc and leave a link to it in the readme
  2. remove most of contents in readme with only the simplest examples.

We can however, add a demo, even as simple as a screen recording with a terminal view, to the readme page.

I think the readme page serves a quick intro to show what this library aims at, and the docs is the must read for anybody who wants to use our library. Just to give two examples:

  1. https://github.com/pydantic/pydantic
  2. https://github.com/tinygrad/tinygrad?tab=readme-ov-file
XuhuiZhou commented 1 month ago

Another example could be:

  1. https://github.com/camel-ai/camel

They seem to facilitate an active community there

XuhuiZhou commented 1 month ago

The crewAI one looks pretty cool too: https://www.crewai.com/