Open-Assistant icon indicating copy to clipboard operation
Open-Assistant copied to clipboard
verified publisher icon LAION-AI

Create an FAQ.md

Open andrewm4894 opened this issue 2 years ago • 4 comments

Create an FAQ section and add it to docs site.

  • create a /docs/docs/faq/faq.md file.
  • update /docs/sidebar.js to add it to sidebar of docs site.

I'd be happy to help anyone with this if i don't get to it first,

andrewm4894 avatar Jan 09 '23 12:01 andrewm4894

Things I've seen as frequently asked so far that need to be added there:

  • docker versions not being up-to-date
  • running docker-compose instead of docker compose
  • pre-commit - how to install/how to use

kostiak avatar Jan 09 '23 12:01 kostiak

Hey, I am interested in helping out in this!

c00kie123 avatar Jan 09 '23 13:01 c00kie123

Cool - maybe as a first step see if you can follow the instructions here to get a local version of the docs site up and running: https://github.com/LAION-AI/Open-Assistant/tree/main/docs#docs-site

andrewm4894 avatar Jan 09 '23 13:01 andrewm4894

Can help in that! Can start the following PR.

nil-andreu avatar Jan 09 '23 22:01 nil-andreu

I wanna improve FAQ.md make new issues and solve that?

kamyardl avatar Mar 16 '23 11:03 kamyardl