Docs site poc

[andrewm4894]

related to this issue: #340

you can see the docs site create by this branch here: https://andrewm4894.github.io/Open-Assistant/

changes:

• add docusaurus project under /docs
• add gh action to deploy changes under /docs
• run yarn install within devcontainer so users can just do cd docs; yarn start to work on docs and see impacts if they want.

to try this out

create codespace on https://github.com/andrewm4894/Open-Assistant/tree/docs-site-poc

cd docs
yarn install
yarn start

Then the docs site will by default be served on port 3000 so you can look in there and changes should be reflected automatically.

So as you work on docs then you can see impact straight away.

[andrewm4894]

if we merge this then someone with access would just need to go to the github pages part of the repo settings and do this:

We would also need to make one last commit (or small follow on PR) - to update all the andrewm4894 parts of the docusaurus config with LAION-AI. (just have to use andrewm4894 for now to make sure my example site builds from my fork).

[bitplane]

I don't really have the skill level to review js/ts files so just stuck my dirty oar in about .gitignore while reading about docusaurus. It looks really cool. Nice work :)

[andrewm4894]

@yk @andreaskoepf what you think about this - i'm happy to take on any donkey work around maintaining it, helping users add to it and things like that. Just thinking a decent docs site might help onboard people easier over next while and maybe help them to not have to dig through .md files on GH (which they could still do too if they wanted since this really just about packaging up existing .md files to given them a bit of an obvious structure).

[yk]

Very cool, thank you!

[yk]

maybe we can leave this away? how much time does it add?

[andrewm4894]

Takes a few seconds, maybe worth having in default container to make it super easy for people to build docs site in a codespace if they want. Of course all they read need do is change a .md file and the workflow will build or fail so if not like they need to.

But maybe handy to have there to make docs contributions as frictionless as possible.

[yk]

this probably needs to become the main url :)

[andrewm4894]

Yep, I can change all that in one last commit now before we merge this. Was just leaving like that so my site was working.

Will make follow up commit to this branch to replace all the andrewm4894 with LAION-AI

[andrewm4894]

I will resolve conflicts and finalize the urls in one last commit. Will ping again once done.