[PR #191] Add codespell support (config, workflow to detect/not fix) and make it fix few typos #194

New issue

Open

opened 2026-03-02 16:48:13 +03:00 by kerem · 0 comments

kerem commented

2026-03-02 16:48:13 +03:00

Owner

📋 Pull Request Information

Original PR: https://github.com/photoprism/photoprism-docs/pull/191
Author: @yarikoptic
Created: 1/6/2025
Status: 🔄 Open

Base: develop ← Head: enh-codespell

📝 Commits (5)

5335d29 Add github action to codespell master on push and PRs
35d6d11 Add rudimentary codespell config
5515b23 [DATALAD RUNCMD] run codespell throughout fixing typos automagically (but ignoring overall fail due to ambigous ones)
12b3524 fixup markdown table after typo fix
95e1108 [DATALAD RUNCMD] Do interactive fixing of some ambigous typos

📊 Changes

10 files changed (+49 additions, -17 deletions)

View changed files

➕ .codespellrc (+7 -0)
➕ .github/workflows/codespell.yml (+25 -0)
📝 docs/developer-guide/machine-learning/models.md (+2 -2)
📝 docs/developer-guide/media/raw.md (+1 -1)
📝 docs/developer-guide/ui/infinite-scrolling.md (+9 -9)
📝 docs/getting-started/advanced/nginx-proxy-setup.md (+1 -1)
📝 docs/getting-started/nas/synology.md (+1 -1)
📝 docs/getting-started/proxies/haproxy.md (+1 -1)
📝 docs/user-guide/sync/dropbox.md (+1 -1)
📝 docs/user-guide/use-cases/apple.md (+1 -1)

📄 Description

More about codespell: https://github.com/codespell-project/codespell .

I personally introduced it to dozens if not hundreds of projects already and so far only positive feedback.

CI workflow has 'permissions' set only to 'read' so also should be safe.

_{🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.}

## 📋 Pull Request Information **Original PR:** https://github.com/photoprism/photoprism-docs/pull/191 **Author:** [@yarikoptic](https://github.com/yarikoptic) **Created:** 1/6/2025 **Status:** 🔄 Open **Base:** `develop` ← **Head:** `enh-codespell` --- ### 📝 Commits (5) - [`5335d29`](https://github.com/photoprism/photoprism-docs/commit/5335d291669be5931f935dd68bebe15a70733872) Add github action to codespell master on push and PRs - [`35d6d11`](https://github.com/photoprism/photoprism-docs/commit/35d6d116fcab5f8d03230fe0ef3d0252730d14d4) Add rudimentary codespell config - [`5515b23`](https://github.com/photoprism/photoprism-docs/commit/5515b236034aacf78056d29bb552719b0e343beb) [DATALAD RUNCMD] run codespell throughout fixing typos automagically (but ignoring overall fail due to ambigous ones) - [`12b3524`](https://github.com/photoprism/photoprism-docs/commit/12b352431d0918e7e76f76e26f0c74e782736ac5) fixup markdown table after typo fix - [`95e1108`](https://github.com/photoprism/photoprism-docs/commit/95e1108bece8e8cd88256bcdb6b88d8aef0a5c0f) [DATALAD RUNCMD] Do interactive fixing of some ambigous typos ### 📊 Changes **10 files changed** (+49 additions, -17 deletions) <details> <summary>View changed files</summary> ➕ `.codespellrc` (+7 -0) ➕ `.github/workflows/codespell.yml` (+25 -0) 📝 `docs/developer-guide/machine-learning/models.md` (+2 -2) 📝 `docs/developer-guide/media/raw.md` (+1 -1) 📝 `docs/developer-guide/ui/infinite-scrolling.md` (+9 -9) 📝 `docs/getting-started/advanced/nginx-proxy-setup.md` (+1 -1) 📝 `docs/getting-started/nas/synology.md` (+1 -1) 📝 `docs/getting-started/proxies/haproxy.md` (+1 -1) 📝 `docs/user-guide/sync/dropbox.md` (+1 -1) 📝 `docs/user-guide/use-cases/apple.md` (+1 -1) </details> ### 📄 Description More about codespell: https://github.com/codespell-project/codespell . I personally introduced it to dozens if not hundreds of projects already and so far only positive feedback. CI workflow has 'permissions' set only to 'read' so also should be safe. --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>