open-interpreter icon indicating copy to clipboard operation
open-interpreter copied to clipboard

Add information on how to view the docs

Open a-rbts opened this issue 2 years ago • 2 comments

Is your feature request related to a problem? Please describe.

There seem to be extensive documentation in the doc repo, but those are under some specific format (mdx) that doesn't seem to be compatible with md viewers. I also tried the specific mdx extension for vscode, but this one complains on pretty much every file that some of the descriptor is missing, so I assume the docs need to be built somehow.

Describe the solution you'd like

I case of local use without Internet access, it would be useful to add pointers about how to build the documentation.

Describe alternatives you've considered

No response

Additional context

No response

a-rbts avatar Mar 22 '24 12:03 a-rbts

I think this is a great idea @a-rbts

Would you be interested in taking on this task? The docs are through Mintlify

The steps for launching the docs locally are

  • cd docs/
  • mintlify dev

MikeBirdTech avatar Mar 25 '24 20:03 MikeBirdTech

@MikeBirdTech, if @a-rbts doesn't take it in the next 24 hours, I'm willing to tackle this low-hanging fruit.

dheavy avatar Mar 31 '24 20:03 dheavy