Skip to content

Commit 1532658

Browse files
committed
improve README
1 parent 1deff9a commit 1532658

1 file changed

Lines changed: 26 additions & 28 deletions

File tree

README.md

Lines changed: 26 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,19 @@
1-
# LangChain Documentation RAG
1+
# LangChainDoc.com - Backend RAG System
22

3-
A simple RAG (Retrieval Augmented Generation) system for querying LangChain documentation using LangGraph.
4-
5-
[![CI](https://github.com/langchain-ai/rag-research-agent-template/actions/workflows/unit-tests.yml/badge.svg)](https://github.com/langchain-ai/rag-research-agent-template/actions/workflows/unit-tests.yml)
3+
The backend powering [LangChainDoc.com](https://langchaindoc.com) - a RAG system for querying LangChain documentation.
64

75
## Overview
86

9-
This project provides a simple way to query LangChain documentation using a retrieval-based system. It uses:
7+
This project provides the backend for LangChainDoc.com, enabling querying of LangChain documentation. It uses:
108

11-
- LangGraph for orchestrating the retrieval and response generation
12-
- Vector database for storing and retrieving documentation content
13-
- LLMs for generating natural language responses
9+
- **LangGraph** for orchestrating the retrieval and response generation
10+
- **Vector database** for storing and retrieving documentation content
11+
- **LLMs** for generating responses with developer insights
1412

1513
## Features
1614

17-
- Document indexing for LangChain documentation
18-
- Natural language querying of documentation content
19-
- Contextual responses based on retrieved documentation
15+
- **Semantic Search**: Find relevant documentation based on meaning
16+
- **Context-Aware Responses**: Responses consider multiple documentation sources
2017

2118
## Getting Started
2219

@@ -32,27 +29,28 @@ ELASTICSEARCH_URL=<your-url>
3229
ELASTICSEARCH_API_KEY=<your-key>
3330
```
3431

35-
3. Index the documentation:
36-
```python
37-
python index.py
38-
```
32+
## Running with LangGraph Studio
3933

40-
4. Start querying the documentation:
41-
```python
42-
python query.py "How do I use LangChain agents?"
43-
```
34+
- **Mac users**: Use LangGraph Studio directly
35+
- **Windows users**: Follow [this tutorial](https://langchain-ai.github.io/langgraph/tutorials/langgraph-platform/local-server/#langgraph-studio-web-ui) to set up LangGraph Studio
36+
37+
## Integration with Frontend
38+
39+
This backend system works with the [LangChainDoc Client](https://github.com/lucebert/langchain-doc-client) to provide a complete user experience.
40+
41+
## About the Creator
42+
43+
This project is maintained by [Luc Ebert](https://www.linkedin.com/in/luc-ebert/), a LangChain developer.
44+
45+
## Contributing
4446

45-
## Customize
47+
Contributions are welcome! Please feel free to submit a Pull Request.
4648

47-
You can customize the:
48-
- Vector store (Elasticsearch, MongoDB, Pinecone)
49-
- Embedding model
50-
- Language model for responses
51-
- System prompts and retrieval parameters
49+
## License
5250

53-
Check the configuration files for available options.
51+
[MIT License](LICENSE)
5452

55-
## Development
53+
## Contact
5654

57-
See the [LangGraph documentation](https://github.com/langchain-ai/langgraph) for more details on extending functionality.
55+
For questions and support, please open an issue in the repository.
5856

0 commit comments

Comments
 (0)