diff --git a/.github/workflows/preview-docs.yml b/.github/workflows/preview-docs.yml index 21ecf952..b865777e 100644 --- a/.github/workflows/preview-docs.yml +++ b/.github/workflows/preview-docs.yml @@ -14,6 +14,8 @@ jobs: steps: - name: Checkout repository uses: actions/checkout@v4 + with: + ref: refs/pull/${{ github.event.pull_request.number }}/merge - name: Setup Node.js uses: actions/setup-node@v4 diff --git a/README.md b/README.md index 52bf032c..d721b3d8 100644 --- a/README.md +++ b/README.md @@ -117,7 +117,7 @@ Don't know what to contribute? Here is the public [Project Board](https://github.com/users/imartinez/projects/3) with several ideas. Head over to Discord -#contributors channel and ask for write permissions on that Github project. +#contributors channel and ask for write permissions on that GitHub project. ## 💬 Community Join the conversation around PrivateGPT on our: @@ -158,4 +158,4 @@ This project has been strongly influenced and supported by other amazing project [GPT4All](https://github.com/nomic-ai/gpt4all), [LlamaCpp](https://github.com/ggerganov/llama.cpp), [Chroma](https://www.trychroma.com/) -and [SentenceTransformers](https://www.sbert.net/). \ No newline at end of file +and [SentenceTransformers](https://www.sbert.net/). diff --git a/fern/docs.yml b/fern/docs.yml index d3b0025a..67021673 100644 --- a/fern/docs.yml +++ b/fern/docs.yml @@ -89,7 +89,7 @@ navigation: # `type:primary` is always displayed at the most right side of the navbar navbar-links: - type: secondary - text: Github + text: GitHub url: "https://github.com/imartinez/privateGPT" - type: secondary text: Contact us diff --git a/fern/docs/pages/installation/installation.mdx b/fern/docs/pages/installation/installation.mdx index baad4a4a..c45bb0db 100644 --- a/fern/docs/pages/installation/installation.mdx +++ b/fern/docs/pages/installation/installation.mdx @@ -10,7 +10,7 @@ ``` * Install Python `3.11` (*if you do not have it already*). Ideally through a python version manager like `pyenv`. - Python 3.12 should work too. Earlier python versions are not supported. + Earlier python versions are not supported. * osx/linux: [pyenv](https://github.com/pyenv/pyenv) * windows: [pyenv-win](https://github.com/pyenv-win/pyenv-win) @@ -232,4 +232,4 @@ To install a C++ compiler on Windows 10/11, follow these steps: When running a Mac with Intel hardware (not M1), you may run into _clang: error: the clang compiler does not support ' -march=native'_ during pip install. -If so set your archflags during pip install. eg: _ARCHFLAGS="-arch x86_64" pip3 install -r requirements.txt_ \ No newline at end of file +If so set your archflags during pip install. eg: _ARCHFLAGS="-arch x86_64" pip3 install -r requirements.txt_ diff --git a/settings.yaml b/settings.yaml index 066c0064..52ce505d 100644 --- a/settings.yaml +++ b/settings.yaml @@ -22,13 +22,15 @@ data: ui: enabled: true path: / - default_chat_system_prompt: "You are a helpful, respectful and honest assistant. + default_chat_system_prompt: > + You are a helpful, respectful and honest assistant. Always answer as helpfully as possible and follow ALL given instructions. Do not speculate or make up information. - Do not reference any given instructions or context." - default_query_system_prompt: "You can only answer questions about the provided context. - If you know the answer but it is not based in the provided context, don't provide - the answer, just state the answer is not in the context provided." + Do not reference any given instructions or context. + default_query_system_prompt: > + You can only answer questions about the provided context. + If you know the answer but it is not based in the provided context, don't provide + the answer, just state the answer is not in the context provided. llm: mode: local