From ab3c124ffb8d80ef26bc24be1a66b9ad4d82c794 Mon Sep 17 00:00:00 2001 From: Bagatur <22008038+baskaryan@users.noreply.github.com> Date: Wed, 25 Oct 2023 12:28:43 -0700 Subject: [PATCH] Add dev guide to docs(#12291) copy CONTRIBUTING.md to docs --- .github/CONTRIBUTING.md | 4 ++-- docs/.local_build.sh | 1 + docs/docusaurus.config.js | 4 ++++ docs/vercel_build.sh | 1 + 4 files changed, 8 insertions(+), 2 deletions(-) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index f70fd1774..0940d61bc 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -77,7 +77,7 @@ tell Poetry to use the virtualenv python environment (`poetry config virtualenvs There are two separate projects in this repository: - `langchain`: core langchain code, abstractions, and use cases -- `langchain.experimental`: see the [Experimental README](../libs/experimental/README.md) for more information. +- `langchain.experimental`: see the [Experimental README](https://github.com/langchain-ai/langchain/tree/master/libs/experimental/README.md) for more information. Each of these has its own development environment. Docs are run from the top-level makefile, but development is split across separate test & release flows. @@ -129,7 +129,7 @@ To run unit tests in Docker: make docker_tests ``` -There are also [integration tests and code-coverage](../libs/langchain/tests/README.md) available. +There are also [integration tests and code-coverage](https://github.com/langchain-ai/langchain/tree/master/libs/langchain/tests/README.md) available. ### Formatting and Linting diff --git a/docs/.local_build.sh b/docs/.local_build.sh index 0d74b4fa8..8d8c0ffe8 100755 --- a/docs/.local_build.sh +++ b/docs/.local_build.sh @@ -14,6 +14,7 @@ cd ../_dist poetry run python scripts/model_feat_table.py poetry run nbdoc_build --srcdir docs cp ../cookbook/README.md src/pages/cookbook.mdx +cp ../.github/CONTRIBUTING.md docs/contributing.md poetry run python scripts/generate_api_reference_links.py yarn install yarn start diff --git a/docs/docusaurus.config.js b/docs/docusaurus.config.js index fa97988ce..ff0cfe102 100644 --- a/docs/docusaurus.config.js +++ b/docs/docusaurus.config.js @@ -173,6 +173,10 @@ const config = { to: "/docs/community", label: "Community", }, + { + to: "/docs/contributing", + label: "Developer's guide", + }, { to: "/docs/additional_resources/dependents", label: "Dependents", diff --git a/docs/vercel_build.sh b/docs/vercel_build.sh index f228fc173..16ae619ac 100755 --- a/docs/vercel_build.sh +++ b/docs/vercel_build.sh @@ -49,4 +49,5 @@ python3.11 -m pip install -r vercel_requirements.txt python3.11 scripts/model_feat_table.py nbdoc_build --srcdir docs cp ../cookbook/README.md src/pages/cookbook.mdx +cp ../.github/CONTRIBUTING.md docs/contributing.md python3.11 scripts/generate_api_reference_links.py