mirror of
https://github.com/hwchase17/langchain.git
synced 2025-05-21 23:17:48 +00:00
9d1867c77f
**Description:** Update Indexing API docs to specify vectorstores that are compatible with the Indexing API. I add a unit test to remind developers to update the documentation whenever they add or change a vectorstore in a way that affects compatibility. For the unit test I repurposed existing code from [here](https://github.com/langchain-ai/langchain/blob/v0.0.311/libs/langchain/langchain/indexes/_api.py#L245-L257). This is my first PR to an open source project. This is a trivially simple PR whose main purpose is to make me more comfortable submitting Langchain PRs. If this PR goes through I plan to submit PRs with more substantive changes in the near future. **Issue:** Resolves [10482](https://github.com/langchain-ai/langchain/discussions/10482). **Dependencies:** No new dependencies. **Twitter handle:** None. |
||
|---|---|---|
| .. | ||
| api_reference | ||
| docs | ||
| docs_skeleton/docs/guides/langsmith | ||
| extras | ||
| scripts | ||
| snippets | ||
| src | ||
| static | ||
| .local_build.sh | ||
| babel.config.js | ||
| code-block-loader.js | ||
| docusaurus.config.js | ||
| package-lock.json | ||
| package.json | ||
| README.md | ||
| settings.ini | ||
| sidebars.js | ||
| vercel_build.sh | ||
| vercel_requirements.txt | ||
| vercel.json | ||
Website
This website is built using Docusaurus 2, a modern static website generator.
Installation
$ yarn
Local Development
$ yarn start
This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
Build
$ yarn build
This command generates static content into the build directory and can be served using any static contents hosting service.
Deployment
Using SSH:
$ USE_SSH=true yarn deploy
Not using SSH:
$ GIT_USER=<Your GitHub username> yarn deploy
If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the gh-pages branch.
Continuous Integration
Some common defaults for linting/formatting have been set for you. If you integrate your project with an open-source Continuous Integration system (e.g. Travis CI, CircleCI), you may check for issues using the following command.
$ yarn ci