Skip to content

docs: add GLM-OCR to README documentation#312

Merged
marcusquinn merged 1 commit intomainfrom
docs/glm-ocr-readme
Feb 4, 2026
Merged

docs: add GLM-OCR to README documentation#312
marcusquinn merged 1 commit intomainfrom
docs/glm-ocr-readme

Conversation

@marcusquinn
Copy link
Owner

Summary

Documents the new GLM-OCR feature in the README, following up on PR #311 which added the subagent.

Changes

Document Processing & OCR section

  • Added GLM-OCR entry with description
  • Added OCR Tool Selection table to help users choose between GLM-OCR, Unstract, Peekaboo, and LibPDF
  • Added quick start example

MCP Integrations > By Category

  • Added GLM-OCR to Document Processing & OCR category

Related

- Add GLM-OCR to Document Processing & OCR section
- Add OCR Tool Selection table with decision guidance
- Add quick start example for GLM-OCR usage
- Update MCP integrations category with GLM-OCR entry
- Reference the new tools/ocr/glm-ocr.md subagent
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Feb 4, 2026

Warning

Rate limit exceeded

@marcusquinn has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 4 minutes and 16 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch docs/glm-ocr-readme

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@gemini-code-assist
Copy link

Summary of Changes

Hello @marcusquinn, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request enhances the project's documentation by integrating comprehensive information about the recently added GLM-OCR feature into the README.md. It aims to provide users with clear guidance on its functionality, how it compares to other OCR tools, and practical examples for quick adoption, thereby improving the overall user experience and understanding of the project's document processing capabilities.

Highlights

  • GLM-OCR Documentation: The new GLM-OCR feature has been comprehensively documented in the README.md file.
  • OCR Tool Selection Guide: A new table has been added to help users choose between GLM-OCR, Unstract, Peekaboo, and LibPDF for various OCR needs.
  • Quick Start Example: A quick start example for using GLM-OCR with Ollama commands has been included for easy adoption.
  • Section Renaming and Categorization: The 'Document Processing' section was updated to 'Document Processing & OCR', and GLM-OCR was added to the relevant category in MCP Integrations.
Changelog
  • README.md
    • The 'Document Processing' section header was updated to 'Document Processing & OCR' to reflect the expanded scope.
    • A new entry for GLM-OCR was added, detailing its local OCR capabilities via Ollama for complex document layouts.
    • An 'OCR Tool Selection' table was introduced, offering a comparative guide for choosing between GLM-OCR, Unstract, Peekaboo, and LibPDF based on specific needs.
    • A quick start guide with ollama pull and ollama run commands for GLM-OCR was included.
    • GLM-OCR was added to the 'Document Processing & OCR' category within the 'MCP Integrations > By Category' section.
Activity
Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

@sonarqubecloud
Copy link

sonarqubecloud bot commented Feb 4, 2026

Copy link

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

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

Code Review

This pull request effectively documents the new GLM-OCR feature in the README. The changes are well-structured, adding the new tool to relevant sections, providing a helpful tool selection table, and a quick start guide. My feedback includes a minor suggestion to improve the consistency of the "OCR Tool Selection" table for better readability. Overall, this is a great documentation update.

|------|------|-----|
| **Quick text extraction** | GLM-OCR | Local, fast, no API keys, privacy-first |
| **Structured JSON output** | Unstract | Schema-based extraction, complex documents |
| **Screen/window OCR** | Peekaboo + GLM-OCR | `peekaboo image --analyze --model ollama/glm-ocr` |

Choose a reason for hiding this comment

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

medium

For consistency with other entries in the 'OCR Tool Selection' table, consider adding a brief explanation to the 'Why' column. Currently, it only contains a command, whereas other rows explain the benefit of the tool. A short description would improve clarity for users comparing options.

Suggested change
| **Screen/window OCR** | Peekaboo + GLM-OCR | `peekaboo image --analyze --model ollama/glm-ocr` |
| **Screen/window OCR** | Peekaboo + GLM-OCR | For OCR on screenshots or active windows, e.g., `peekaboo image --analyze --model ollama/glm-ocr` |

@github-actions
Copy link
Contributor

github-actions bot commented Feb 4, 2026

🔍 Code Quality Report

�[0;35m[MONITOR]�[0m Code Review Monitoring Report

�[0;34m[INFO]�[0m Latest Quality Status:
SonarCloud: 0 bugs, 0 vulnerabilities, 2 code smells

�[0;34m[INFO]�[0m Recent monitoring activity:
Wed Feb 4 05:19:26 UTC 2026: Code review monitoring started
Wed Feb 4 05:19:27 UTC 2026: SonarCloud - Bugs: 0, Vulnerabilities: 0, Code Smells: 2
Wed Feb 4 05:19:27 UTC 2026: Qlty - 0 issues found, auto-formatting applied
Wed Feb 4 05:19:29 UTC 2026: Codacy analysis completed with auto-fixes

📈 Current Quality Metrics

  • BUGS: 0
  • CODE SMELLS: 2
  • VULNERABILITIES: 0

Generated on: Wed Feb 4 05:21:01 UTC 2026


Generated by AI DevOps Framework Code Review Monitoring

@marcusquinn marcusquinn merged commit 11d51a5 into main Feb 4, 2026
11 checks passed
@marcusquinn marcusquinn deleted the docs/glm-ocr-readme branch February 21, 2026 01:59
@marcusquinn marcusquinn added the code-reviews-actioned All review feedback has been actioned label Mar 7, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

code-reviews-actioned All review feedback has been actioned

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant