Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README.md with instructions about raising an issue. #45

Closed
wants to merge 5 commits into from
Closed
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 17 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -103,10 +103,25 @@ You can set the configuration either through natural language or manually for bo
- **Embeddings**: Supports text-embedding-ada-002 by default, but also supports Hugging Face models. To use a hugging face model simply prepend with local, e.g. local:BAAI/bge-small-en.


## Resources

Running into issues? Please file a GitHub issue or join our [Discord](https://discord.gg/dGcwcsnxhU).

## Running into issues?
Please file a GitHub issue or join our [Discord](https://discord.gg/dGcwcsnxhU).

When raising an issue please be as descriptive as possible, so others can try to reproduce the issue.
Please following these steps:

### Provide a Title
Write a concise and descriptive title for your issue. This should give a quick overview of the problem or feature you're addressing.

### Describe the Issue
Please provide a detailed description of the issue. Include information such as:
Steps to reproduce the problem (if it's a bug).
The expected behavior.
The actual behavior (if it's a bug).
Screenshots or code snippets, if applicable.

## Resources
This app was built with [LlamaIndex Python](https://github.com/run-llama/llama_index).

See our launch blog post [here](https://blog.llamaindex.ai/introducing-rags-your-personalized-chatgpt-experience-over-your-data-2b9d140769b1).