langchain/docs
Kastan Day 65faba91ad
langchain[patch]: Adding new Github functions for reading pull requests (#9027)
The Github utilities are fantastic, so I'm adding support for deeper
interaction with pull requests. Agents should read "regular" comments
and review comments, and the content of PR files (with summarization or
`ctags` abbreviations).

Progress:
- [x] Add functions to read pull requests and the full content of
modified files.
- [x] Function to use Github's built in code / issues search.

Out of scope:
- Smarter summarization of file contents of large pull requests (`tree`
output, or ctags).
- Smarter functions to checkout PRs and edit the files incrementally
before bulk committing all changes.
- Docs example for creating two agents:
- One watches issues: For every new issue, open a PR with your best
attempt at fixing it.
- The other watches PRs: For every new PR && every new comment on a PR,
check the status and try to finish the job.

<!-- Thank you for contributing to LangChain!

Replace this comment with:
  - Description: a description of the change, 
  - Issue: the issue # it fixes (if applicable),
  - Dependencies: any dependencies required for this change,
- Tag maintainer: for a quicker response, tag the relevant maintainer
(see below),
- Twitter handle: we announce bigger features on Twitter. If your PR
gets announced and you'd like a mention, we'll gladly shout you out!

Please make sure you're PR is passing linting and testing before
submitting. Run `make format`, `make lint` and `make test` to check this
locally.

If you're adding a new integration, please include:
1. a test for the integration, preferably unit tests that do not rely on
network access,
  2. an example notebook showing its use.

Maintainer responsibilities:
  - General / Misc / if you don't know who to tag: @baskaryan
  - DataLoaders / VectorStores / Retrievers: @rlancemartin, @eyurtsev
  - Models / Prompts: @hwchase17, @baskaryan
  - Memory: @hwchase17
  - Agents / Tools / Toolkits: @hinthornw
  - Tracing / Callbacks: @agola11
  - Async: @agola11

If no one reviews your PR within a few days, feel free to @-mention the
same people again.

See contribution guidelines for more information on how to write/run
tests, lint, etc:
https://github.com/hwchase17/langchain/blob/master/.github/CONTRIBUTING.md
 -->

---------

Co-authored-by: Erick Friis <erick@langchain.dev>
2023-12-04 15:53:36 -08:00
..
api_reference DOCS: core editable dep api refs (#13747) 2023-11-22 14:33:30 -08:00
docs langchain[patch]: Adding new Github functions for reading pull requests (#9027) 2023-12-04 15:53:36 -08:00
scripts DOCS: format notebooks (#13371) 2023-11-14 14:17:44 -08:00
src docs[minor]: lcel why page (#14089) 2023-12-01 16:13:31 -08:00
static docs[patch]: update stack diagram (#13902) 2023-11-28 14:19:13 -08:00
.local_build.sh nbdoc -> quarto (#14156) 2023-12-04 12:50:56 -08:00
babel.config.js
code-block-loader.js
docusaurus.config.js docs[patch]: added Templates Hub menu item (#14148) 2023-12-03 15:36:35 -08:00
package-lock.json docs[patch]: Add mermaid JS theme dependency to docusaurus (#14051) 2023-12-01 11:06:29 -08:00
package.json docs[patch]: Add mermaid JS theme dependency to docusaurus (#14051) 2023-12-01 11:06:29 -08:00
README.md
settings.ini
sidebars.js DOCS: move adapters to integrations (#13862) 2023-11-27 13:05:43 -08:00
vercel_build.sh nbdoc -> quarto (#14156) 2023-12-04 12:50:56 -08:00
vercel_requirements.txt nbdoc -> quarto (#14156) 2023-12-04 12:50:56 -08:00
vercel.json docs[patch]: moved vectorstore notebook file (#14181) 2023-12-04 14:44:06 -08:00

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