Open-Assistant icon indicating copy to clipboard operation
Open-Assistant copied to clipboard

Suggestion for documentation and issue creation

Open jasonmhead opened this issue 2 years ago • 2 comments

It could be good to include some base suggested reading for tasks for people who aren't familiar with the frameworks being used.

Perhaps when a task is created a link to some documentation that would help point someone in the right direction to complete the task.

I know the project is evolving and there isn't wiki content/other documentation on code structure for the code base, but some minimal links to resources on the web could be helpful in getting some people upto speed.

jasonmhead avatar Dec 28 '22 10:12 jasonmhead

I like this idea. I've tried to do this on the webside.

Are there specific READMEs that felt incomplete? It'd be helpful to list specific docs we should update and enhance.

fozziethebeat avatar Dec 28 '22 11:12 fozziethebeat

I'd be down to copyedit work on this one as well, but yeah we should have some examples of specific md and docs where it would make sense to update content would be helpful. Honestly, an epic on setting up a wiki would probably be good too.

MalikMAlna avatar Feb 06 '23 02:02 MalikMAlna

sry, misread this as it is more general about documentation. I still close it because it is too vague, the project evolved since end of December. If you feel a specific page in the documentation or important information regarding the development-setup is missing please feel free to open a separate issue.

andreaskoepf avatar Feb 20 '23 13:02 andreaskoepf