Skip to content

Commit 023eada

Browse files
Merge branch 'main' into integrations/opendataloader
2 parents 21cf38e + c1f5547 commit 023eada

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

87 files changed

+5921
-478
lines changed

IDE_SETUP.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ This repository includes configuration files to ensure consistent formatting acr
66

77
### VSCode
88

9-
If you're using Visual Studio Code, the settings in `.vscode/settings.json` will be automatically applied when you open this project. No additional setup required.
9+
If you're using Visual Studio Code, the settings in `.vscode/settings.json` should be automatically applied when you open this project. No additional setup required.
1010

1111
### Other IDEs
1212

Makefile

Lines changed: 13 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -72,6 +72,7 @@ broken-links: build
7272
check-pnpm:
7373
@command -v pnpm >/dev/null 2>&1 || { echo >&2 "pnpm is not installed. Please install pnpm to proceed (https://pnpm.io/installation)"; exit 1; }
7474

75+
# Reference docs commands (in reference/ subdirectory)
7576
build-references: check-pnpm
7677
@echo "Building references..."
7778
cd reference && pnpm i && pnpm build
@@ -82,16 +83,16 @@ preview-references: check-pnpm
8283

8384
help:
8485
@echo "Available commands:"
85-
@echo " make dev - Start development mode with file watching and mint dev"
86-
@echo " make build - Build documentation to ./build directory"
87-
@echo " make broken-links - Check for broken links in built documentation"
88-
@echo " make build-references - Build reference docs"
86+
@echo " make dev - Start development mode with file watching and mint dev"
87+
@echo " make build - Build documentation to ./build directory"
88+
@echo " make broken-links - Check for broken links in built documentation"
89+
@echo " make build-references - Build reference docs"
8990
@echo " make preview-references - Preview reference docs"
90-
@echo " make format - Format code"
91-
@echo " make lint - Lint code"
92-
@echo " make lint_md - Lint markdown files"
93-
@echo " make lint_md_fix - Lint and fix markdown files"
94-
@echo " make test - Run tests"
95-
@echo " make install - Install dependencies"
96-
@echo " make clean - Clean build artifacts"
97-
@echo " make help - Show this help message"
91+
@echo " make format - Format code"
92+
@echo " make lint - Lint code"
93+
@echo " make lint_md - Lint markdown files"
94+
@echo " make lint_md_fix - Lint and fix markdown files"
95+
@echo " make test - Run tests"
96+
@echo " make install - Install dependencies"
97+
@echo " make clean - Clean build artifacts"
98+
@echo " make help - Show this help message"

README.md

Lines changed: 128 additions & 84 deletions
Large diffs are not rendered by default.

reference/.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,2 @@
11
.vercel
2+
.cache

reference/README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# LangChain Reference Docs
2+
3+
Reference documentation is not consolidated into our primary Mintlify website ([`docs.langchain.com`](https://docs.langchain.com)) due to limitations in the Mintlify platform. Instead, we deploy static documentation sites for our Python and JavaScript/TypeScript references.
4+
5+
Currently, a Vercel project serves the built HTML from the `dist/language` directories at [`reference.langchain.com/python`](https://reference.langchain.com/python) and [`reference.langchain.com/javascript`](https://reference.langchain.com/javascript).
6+
7+
See the [`reference/python/README.md`](./python/README.md) and [`reference/javascript/README.md`](./javascript/README.md) files for more information on how each are built and deployed.

reference/javascript/.eslintignore

Lines changed: 0 additions & 5 deletions
This file was deleted.

reference/javascript/.eslintrc.cjs

Lines changed: 0 additions & 18 deletions
This file was deleted.

reference/javascript/.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,3 +9,4 @@ node_modules
99
!package.json
1010
!pnpm-lock.yaml
1111
!tsconfig.json
12+
!README.md

reference/javascript/.prettierrc

Lines changed: 14 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,19 @@
11
{
2-
"semi": true,
3-
"singleQuote": true,
2+
"$schema": "https://json.schemastore.org/prettierrc",
3+
"printWidth": 80,
44
"tabWidth": 2,
5+
"useTabs": false,
6+
"semi": true,
7+
"singleQuote": false,
8+
"quoteProps": "as-needed",
9+
"jsxSingleQuote": false,
510
"trailingComma": "es5",
6-
"printWidth": 100,
711
"bracketSpacing": true,
8-
"arrowParens": "always"
12+
"arrowParens": "always",
13+
"requirePragma": false,
14+
"insertPragma": false,
15+
"proseWrap": "preserve",
16+
"htmlWhitespaceSensitivity": "css",
17+
"vueIndentScriptAndStyle": false,
18+
"endOfLine": "lf"
919
}

reference/javascript/README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# LangChain TypeScript Reference Documentation
2+
3+
This directory contains the source code and build process for the TypeScript reference documentation site, hosted at [`reference.langchain.com/javascript`](https://reference.langchain.com/javascript). This site serves references for LangChain, LangGraph, LangGraph Platform, and LangChain integration packages (such as [`@langchain/anthropic`](https://npm.com/package/@langchain/anthropic), [`@langchain/openai`](https://npm.com/package/@langchain/openai), etc.).

0 commit comments

Comments
 (0)