OpenHands icon indicating copy to clipboard operation
OpenHands copied to clipboard

docs(docs): start implementing docs website

Open Sparkier opened this issue 1 year ago • 6 comments

I started implementing a dedicated website for documentation and as a landing page.

I'm using docusaurus for this. It is based on react but supports documentation via markdown.

Deployment could be done to a separate branch and hosting could be done via GitHub pages. This way, we don't need an extra service and the build files of the docs don't pollute the repository.

If this is something we want to pursue, I'd want to clean this up a little bit and reference it from our main readme.

fix https://github.com/OpenDevin/OpenDevin/issues/73

Sparkier avatar Apr 26 '24 00:04 Sparkier

https://github.com/OpenDevin/OpenDevin/assets/5690524/e868d04c-4d1f-4bfb-a037-02f8aef11c73

Sparkier avatar Apr 26 '24 00:04 Sparkier

https://github.com/OpenDevin/OpenDevin/assets/5690524/fd2d12db-7a46-4d99-b97d-2fd54ef83759

Sparkier avatar Apr 26 '24 17:04 Sparkier

@Sparkier Do you know why the pydoc-markdown pre-commit hook is failing? It seems to error but without output.

yimothysu avatar Apr 27 '24 21:04 yimothysu

@Sparkier Do you know why the pydoc-markdown pre-commit hook is failing? It seems to error but without output.

I think this is because some of the other hooks (e.g. trailing-whitespace) change the formatting of those files. Then, once pydoc-markdown is run, all of them change again so things fail.

2024-04-27 at 14 26 13

Sparkier avatar Apr 27 '24 21:04 Sparkier

@yimothysu I think we need to exclude this autogenerated python dir for some hooks so that precommit works. Seems to work now.

Sparkier avatar Apr 27 '24 21:04 Sparkier

@Sparkier this is great! LMK when you have the conflicts addressed and we can get it in

rbren avatar Apr 29 '24 14:04 rbren