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

ci: add codespell support (config, workflow to detect/not fix) and make it fix few typos #349

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
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
6 changes: 6 additions & 0 deletions .codespellrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
[codespell]
# Ref: https://github.com/codespell-project/codespell#using-a-config-file
skip = .git*,*.svg,package-lock.json,*.css,.codespellrc
check-hidden = true
# ignore-regex =
# ignore-words-list =
25 changes: 25 additions & 0 deletions .github/workflows/codespell.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# Codespell configuration is within .codespellrc
---
name: Codespell

on:
push:
branches: [main]
pull_request:
branches: [main]

permissions:
contents: read

jobs:
codespell:
name: Check for spelling errors
runs-on: ubuntu-latest

steps:
- name: Checkout
uses: actions/checkout@v4
- name: Annotate locations with typos
uses: codespell-project/codespell-problem-matcher@v1
- name: Codespell
uses: codespell-project/actions-codespell@v2
6 changes: 3 additions & 3 deletions docs/features/plugin/functions/tab-shared/Common.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Valves are configurable by admins alone and UserValves are configurable by any u
default=0, description="Priority level for the filter operations."
)
test_valve: int = Field(
default=4, description="A valve controlling a numberical value"
default=4, description="A valve controlling a numerical value"
)
pass

Expand Down Expand Up @@ -85,7 +85,7 @@ async def test_function(
await __event_emitter__(
{
"type": "status",
"data": {"description": f"An error occured: {e}", "done": True},
"data": {"description": f"An error occurred: {e}", "done": True},
}
)

Expand Down Expand Up @@ -131,7 +131,7 @@ async def test_function(
await __event_emitter__(
{
"type": "status",
"data": {"description": f"An error occured: {e}", "done": True},
"data": {"description": f"An error occurred: {e}", "done": True},
}
)

Expand Down
8 changes: 4 additions & 4 deletions docs/features/plugin/tools/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ licence: MIT

### Tools Class

Tools have to be defined as methods withing a class called `Tools`, with optional subclasses called `Valves` and `UserValves`, for example:
Tools have to be defined as methods within a class called `Tools`, with optional subclasses called `Valves` and `UserValves`, for example:

```python
class Tools:
Expand Down Expand Up @@ -109,7 +109,7 @@ Valves are configurable by admins alone and UserValves are configurable by any u
default=0, description="Priority level for the filter operations."
)
test_valve: int = Field(
default=4, description="A valve controlling a numberical value"
default=4, description="A valve controlling a numerical value"
)
pass

Expand Down Expand Up @@ -188,7 +188,7 @@ async def test_function(
await __event_emitter__(
{
"type": "status",
"data": {"description": f"An error occured: {e}", "done": True},
"data": {"description": f"An error occurred: {e}", "done": True},
}
)

Expand Down Expand Up @@ -234,7 +234,7 @@ async def test_function(
await __event_emitter__(
{
"type": "status",
"data": {"description": f"An error occured: {e}", "done": True},
"data": {"description": f"An error occurred: {e}", "done": True},
}
)

Expand Down
2 changes: 1 addition & 1 deletion docs/features/workspace/knowledge.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,6 @@ Admins can add knowledge to the workspace, which users can access and use; howev

- The Knowledge section is like Open WebUI's "memory bank," where you can store data that you want it to remember and use.
- **Use Knowledge to keep the system aware** of important details, ensuring a personalized chat experience.
- You can **directly reference Knowledge in chats** to bring in stored data whenever you need it using '#' + name of the knowlege.
- You can **directly reference Knowledge in chats** to bring in stored data whenever you need it using '#' + name of the knowledge.

🌟 Remember, there’s always more to discover, so dive in and make Open WebUI truly your own!
2 changes: 1 addition & 1 deletion docs/getting-started/quick-start/tab-docker/DockerSwarm.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
## Docker Swarm

This installation method requires knowledge on Docker Swarms, as it utilizes a stack file to deploy 3 seperate containers as services in a Docker Swarm.
This installation method requires knowledge on Docker Swarms, as it utilizes a stack file to deploy 3 separate containers as services in a Docker Swarm.

It includes isolated containers of ChromaDB, Ollama, and OpenWebUI.
Additionally, there are pre-filled [Environment Variables](../advanced-topics/env-configuration) to further illustrate the setup.
Expand Down
2 changes: 1 addition & 1 deletion docs/getting-started/updating.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ docker pull ghcr.io/open-webui/open-webui:main


:::info
**Remove any existing data in the Docker volume (NOT RECOMMENDED UNLESS ABSOLUTELY NECCESSARY!)**. Skip this step entirely if not needed and move on to the last step:
**Remove any existing data in the Docker volume (NOT RECOMMENDED UNLESS ABSOLUTELY NECESSARY!)**. Skip this step entirely if not needed and move on to the last step:

If you want to start with a clean slate, you can remove the existing data in the Docker volume. Be careful, as this will delete all your chat histories and other data.

Expand Down
2 changes: 1 addition & 1 deletion docs/tutorials/integrations/apache.md
Original file line number Diff line number Diff line change
Expand Up @@ -142,7 +142,7 @@ Navigate to the apache sites-available directory:

`nano models.server.city.conf` # match this with your ollama server domain

Add the follwoing virtualhost containing this example (modify as needed):
Add the following virtualhost containing this example (modify as needed):

```

Expand Down
6 changes: 3 additions & 3 deletions docs/tutorials/integrations/continue-dev.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ Here you'll be able to configure continue to use Open WebUI.

Currently the 'ollama' provider does not support authentication so we cannot use this provider with Open WebUI.

However Ollama and Open WebUI both have compatibily with OpenAI API spec. You can see a blog post from Ollama [here](https://ollama.com/blog/openai-compatibility) on this.
However Ollama and Open WebUI both have compatibility with OpenAI API spec. You can see a blog post from Ollama [here](https://ollama.com/blog/openai-compatibility) on this.

We can still setup Continue to use the openai provider which will allow us to use Open WebUI's authentication token.

Expand Down Expand Up @@ -94,12 +94,12 @@ Make sure you pull the model into your ollama instance/s beforehand.
}
```

Save your `config.json` and thats it!
Save your `config.json` and that's it!

You should now see your model in the Continue tab model selection.

Select it and you should now be chatting via Open WebUI (and or any [pipelines](/pipelines) you have setup )

You can do this for as many models you would like to use, altough any model should work, you should use a model that is designed for code.
You can do this for as many models you would like to use, although any model should work, you should use a model that is designed for code.

See the continue documentation for additional continue configuration, [Continue Documentation](https://docs.continue.dev/reference/Model%20Providers/openai)
2 changes: 1 addition & 1 deletion src/components/TopBanners.tsx
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Incorrect last name here.

Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ export const TopBanners = () => {
imgSrc: "/ads/sponsor-banner-1.png",
mobileImgSrc: "/ads/sponsor-banner-small-1.png",
url: "https://davewaring.com/tag/digital-brain-building/",
name: "Dave Waring",
name: "Dave Warning",
description: "Follow along as I build my own AI powered digital brain.",
},
];
Expand Down