[PR #121] [MERGED] docs: fix typos across documentation and code comments #169

Closed
opened 2026-06-06 22:09:32 -04:00 by yindo · 0 comments
Owner

📋 Pull Request Information

Original PR: https://github.com/vxcontrol/pentagi/pull/121
Author: @mason5052
Created: 2/22/2026
Status: Merged
Merged: 2/22/2026
Merged by: @asdek

Base: feature/project_improvementsHead: docs/fix-typos-and-grammar


📝 Commits (1)

  • 4bb9ca3 docs: fix typos across documentation and code comments

📊 Changes

9 files changed (+18 additions, -18 deletions)

View changed files

📝 EULA.md (+1 -1)
📝 README.md (+2 -2)
📝 backend/docs/config.md (+10 -10)
📝 backend/docs/installer/processor-wizard-integration.md (+0 -0)
📝 backend/docs/installer/terminal-wizard-integration.md (+0 -0)
📝 backend/pkg/server/auth/auth_middleware.go (+1 -1)
📝 backend/pkg/server/services/auth.go (+3 -3)
📝 backend/pkg/server/services/screenshots.go (+0 -0)
📝 frontend/README.md (+1 -1)

📄 Description

Description of the Change

Problem

Multiple typos, inconsistent capitalization, and misspelled filenames across the PentAGI documentation and code:

  • Product name typo "PegtAGI" in frontend/README.md
  • Inconsistent capitalization "PentAGi" (lowercase 'i') in backend/docs/config.md (10 occurrences)
  • Misspelled third-party names in EULA.md: "Depp Infra" (should be "Deep Infra"), "Traversal" (should be "Traversaal")
  • Misleading OAuth env var names in README.md: GITHUB_CLIENT_ID / GOOGLE_CLIENT_ID don't match the actual env vars used in .env.example and docker-compose.yml (OAUTH_GITHUB_CLIENT_ID / OAUTH_GOOGLE_CLIENT_ID)
  • Typo "applacation" in auth.go comments (3 occurrences)
  • Typo "pemissions" in auth_middleware.go error message
  • Misspelled filenames: sreenshots.go, processor-wizard-integation.md, terminal-wizard-integation.md

Solution

  • Fix all product name typos to "PentAGI"
  • Fix third-party service names to match their official branding
  • Update README.md OAuth env var references to match actual config
  • Fix spelling errors in code comments and error messages
  • Rename misspelled source files

Type of Change

  • Documentation update

Areas Affected

  • Core Services (Frontend UI/Backend API)
  • Documentation

Testing and Verification

Test Configuration

PentAGI Version: v1.1.0 (master @ f111863)
Docker Version: N/A (documentation and comment changes)
Host OS: Windows 11
LLM Provider: N/A

Test Steps

  1. Verify all "PentAGI" references are consistently capitalized
  2. Verify OAuth env var names in README match .env.example and docker-compose.yml
  3. Verify renamed files maintain correct Go package declarations and markdown links
  4. Confirm no functional code changes -- only comments, error messages, docs, and filenames

Test Results

  • All changes are cosmetic (documentation, comments, error messages, file renames)
  • No functional code logic was modified
  • File renames preserve original content and package declarations

Security Considerations

No security implications. Changes are limited to documentation, comments, error messages, and file renames.

Performance Impact

None. No functional code changes.

Deployment Notes

No special deployment considerations. File renames (sreenshots.go -> screenshots.go, etc.) may require updating any internal references, but no such references were found in the codebase.

Checklist

Code Quality

  • My code follows the project's coding standards
  • I have added/updated necessary documentation
  • I have added tests to cover my changes
  • All new and existing tests pass
  • I have run go fmt and go vet (for Go code)

Security

  • I have considered security implications
  • Changes maintain or improve the security model
  • Sensitive information has been properly handled

Compatibility

  • Changes are backward compatible
  • Dependencies are properly updated

Documentation

  • Documentation is clear and complete
  • Comments are added for non-obvious code

Additional Notes

Files changed (9):

  • EULA.md -- Fix "Depp Infra" -> "Deep Infra", "Traversal" -> "Traversaal"
  • README.md -- Fix OAuth env var names to match actual config
  • backend/docs/config.md -- Fix "PentAGi" -> "PentAGI" (10 occurrences)
  • backend/pkg/server/auth/auth_middleware.go -- Fix "pemissions" -> "permissions"
  • backend/pkg/server/services/auth.go -- Fix "applacation" -> "application" (3 occurrences)
  • backend/pkg/server/services/sreenshots.go -> screenshots.go (rename)
  • backend/docs/installer/processor-wizard-integation.md -> processor-wizard-integration.md (rename)
  • backend/docs/installer/terminal-wizard-integation.md -> terminal-wizard-integration.md (rename)
  • frontend/README.md -- Fix "PegtAGI" -> "PentAGI"

🔄 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/vxcontrol/pentagi/pull/121 **Author:** [@mason5052](https://github.com/mason5052) **Created:** 2/22/2026 **Status:** ✅ Merged **Merged:** 2/22/2026 **Merged by:** [@asdek](https://github.com/asdek) **Base:** `feature/project_improvements` ← **Head:** `docs/fix-typos-and-grammar` --- ### 📝 Commits (1) - [`4bb9ca3`](https://github.com/vxcontrol/pentagi/commit/4bb9ca31f225cbe9d0ce2fa49e8cd817e0ee795d) docs: fix typos across documentation and code comments ### 📊 Changes **9 files changed** (+18 additions, -18 deletions) <details> <summary>View changed files</summary> 📝 `EULA.md` (+1 -1) 📝 `README.md` (+2 -2) 📝 `backend/docs/config.md` (+10 -10) 📝 `backend/docs/installer/processor-wizard-integration.md` (+0 -0) 📝 `backend/docs/installer/terminal-wizard-integration.md` (+0 -0) 📝 `backend/pkg/server/auth/auth_middleware.go` (+1 -1) 📝 `backend/pkg/server/services/auth.go` (+3 -3) 📝 `backend/pkg/server/services/screenshots.go` (+0 -0) 📝 `frontend/README.md` (+1 -1) </details> ### 📄 Description ### Description of the Change #### Problem Multiple typos, inconsistent capitalization, and misspelled filenames across the PentAGI documentation and code: - Product name typo "PegtAGI" in frontend/README.md - Inconsistent capitalization "PentAGi" (lowercase 'i') in backend/docs/config.md (10 occurrences) - Misspelled third-party names in EULA.md: "Depp Infra" (should be "Deep Infra"), "Traversal" (should be "Traversaal") - Misleading OAuth env var names in README.md: `GITHUB_CLIENT_ID` / `GOOGLE_CLIENT_ID` don't match the actual env vars used in .env.example and docker-compose.yml (`OAUTH_GITHUB_CLIENT_ID` / `OAUTH_GOOGLE_CLIENT_ID`) - Typo "applacation" in auth.go comments (3 occurrences) - Typo "pemissions" in auth_middleware.go error message - Misspelled filenames: `sreenshots.go`, `processor-wizard-integation.md`, `terminal-wizard-integation.md` #### Solution - Fix all product name typos to "PentAGI" - Fix third-party service names to match their official branding - Update README.md OAuth env var references to match actual config - Fix spelling errors in code comments and error messages - Rename misspelled source files ### Type of Change - [x] Documentation update ### Areas Affected - [x] Core Services (Frontend UI/Backend API) - [x] Documentation ### Testing and Verification #### Test Configuration ```yaml PentAGI Version: v1.1.0 (master @ f111863) Docker Version: N/A (documentation and comment changes) Host OS: Windows 11 LLM Provider: N/A ``` #### Test Steps 1. Verify all "PentAGI" references are consistently capitalized 2. Verify OAuth env var names in README match .env.example and docker-compose.yml 3. Verify renamed files maintain correct Go package declarations and markdown links 4. Confirm no functional code changes -- only comments, error messages, docs, and filenames #### Test Results - All changes are cosmetic (documentation, comments, error messages, file renames) - No functional code logic was modified - File renames preserve original content and package declarations ### Security Considerations No security implications. Changes are limited to documentation, comments, error messages, and file renames. ### Performance Impact None. No functional code changes. ### Deployment Notes No special deployment considerations. File renames (`sreenshots.go` -> `screenshots.go`, etc.) may require updating any internal references, but no such references were found in the codebase. ### Checklist #### Code Quality - [x] My code follows the project's coding standards - [x] I have added/updated necessary documentation - [ ] I have added tests to cover my changes - [x] All new and existing tests pass - [x] I have run `go fmt` and `go vet` (for Go code) #### Security - [x] I have considered security implications - [x] Changes maintain or improve the security model - [x] Sensitive information has been properly handled #### Compatibility - [x] Changes are backward compatible - [x] Dependencies are properly updated #### Documentation - [x] Documentation is clear and complete - [x] Comments are added for non-obvious code ### Additional Notes Files changed (9): - `EULA.md` -- Fix "Depp Infra" -> "Deep Infra", "Traversal" -> "Traversaal" - `README.md` -- Fix OAuth env var names to match actual config - `backend/docs/config.md` -- Fix "PentAGi" -> "PentAGI" (10 occurrences) - `backend/pkg/server/auth/auth_middleware.go` -- Fix "pemissions" -> "permissions" - `backend/pkg/server/services/auth.go` -- Fix "applacation" -> "application" (3 occurrences) - `backend/pkg/server/services/sreenshots.go` -> `screenshots.go` (rename) - `backend/docs/installer/processor-wizard-integation.md` -> `processor-wizard-integration.md` (rename) - `backend/docs/installer/terminal-wizard-integation.md` -> `terminal-wizard-integration.md` (rename) - `frontend/README.md` -- Fix "PegtAGI" -> "PentAGI" --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>
yindo added the pull-request label 2026-06-06 22:09:32 -04:00
yindo closed this issue 2026-06-06 22:09:32 -04:00
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: vxcontrol/pentagi#169