langchaingo icon indicating copy to clipboard operation
langchaingo copied to clipboard

docs: finish first version of documentation site

Open FluffyKebab opened this issue 2 years ago • 4 comments
trafficstars

The documentation site is currently missing a lot of content and needs work.

To import code from the examples directory in an mdx file you must write this at the start of the file:

import CodeBlock from "@theme/CodeBlock";
import ExampleLLM from "@examples/llm-chain-example/llm_chain.go";

Then write this where the code should be:

<CodeBlock language="go">{ExampleLLM}</CodeBlock>

FluffyKebab avatar Jun 25 '23 11:06 FluffyKebab

@FluffyKebab what URL renders index.md? I can see the API reference but not the more verbose descriptions. Thanks

cduggn avatar Jun 28 '23 20:06 cduggn

The index.mdx in /docs/ directory is rendered in /docs/. This is the page you are redirected to when visiting /.

FluffyKebab avatar Jun 29 '23 09:06 FluffyKebab

Hi, I would like to contribute to the documentation site. Is there any established process that can help me get started? Thanks!

haochunchang avatar Jan 16 '24 12:01 haochunchang

Hi, I would like to contribute to the documentation site. Is there any established process that can help me get started? Thanks!

We really should have a document that is about that.. Would you be open to authoring a guide?

tmc avatar Mar 19 '24 23:03 tmc