github/langchain
1
0
Fork 0
mirror of https://github.com/hwchase17/langchain.git synced 2025-06-21 14:18:52 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add dev guide to docs(#12291)

Browse Source 
copy CONTRIBUTING.md to docs
This commit is contained in:
Bagatur 2023-10-25 12:28:43 -07:00 committed by GitHub
parent aa212c3d0e
commit ab3c124ffb
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 8 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
.github/CONTRIBUTING.md vendored
View File

@ -77,7 +77,7 @@ tell Poetry to use the virtualenv python environment (`poetry config virtualenvs
There are two separate projects in this repository: There are two separate projects in this repository:
- `langchain`: core langchain code, abstractions, and use cases - `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 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. is split across separate test & release flows.
@ -129,7 +129,7 @@ To run unit tests in Docker:
make docker_tests 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 ### Formatting and Linting

1
docs/.local_build.sh
View File

@ -14,6 +14,7 @@ cd ../_dist
poetry run python scripts/model_feat_table.py poetry run python scripts/model_feat_table.py
poetry run nbdoc_build --srcdir docs poetry run nbdoc_build --srcdir docs
cp ../cookbook/README.md src/pages/cookbook.mdx cp ../cookbook/README.md src/pages/cookbook.mdx
cp ../.github/CONTRIBUTING.md docs/contributing.md
poetry run python scripts/generate_api_reference_links.py poetry run python scripts/generate_api_reference_links.py
yarn install yarn install
yarn start yarn start

4
docs/docusaurus.config.js
View File

@ -173,6 +173,10 @@ const config = {
to: "/docs/community", to: "/docs/community",
label: "Community", label: "Community",
}, },
{
to: "/docs/contributing",
label: "Developer's guide",
},
{ {
to: "/docs/additional_resources/dependents", to: "/docs/additional_resources/dependents",
label: "Dependents", label: "Dependents",

1
docs/vercel_build.sh
View File

@ -49,4 +49,5 @@ python3.11 -m pip install -r vercel_requirements.txt
python3.11 scripts/model_feat_table.py python3.11 scripts/model_feat_table.py
nbdoc_build --srcdir docs nbdoc_build --srcdir docs
cp ../cookbook/README.md src/pages/cookbook.mdx cp ../cookbook/README.md src/pages/cookbook.mdx
cp ../.github/CONTRIBUTING.md docs/contributing.md
python3.11 scripts/generate_api_reference_links.py python3.11 scripts/generate_api_reference_links.py