Formal documentation on what a README should be

jina-ai / executors

internal-only

Apache License 2.0

31 stars 12 forks source link

Formal documentation on what a README should be #239

Closed CatStark closed 2 years ago

CatStark commented 2 years ago

We need to have a more formal definition on what we expect from the executor's READMEs. This can be a work in progress evolving over time but we need a document where to check what is the current status on what is needed

nan-wang commented 2 years ago

A very first draft can be found here: https://docs.google.com/document/d/1UebHh5WDArscXZkT5TKENDdsce0n9KmvkHJkoucBT_w/edit#