Skip to content

Migrate and expand OpenCvSharp usage guides - #2090

Merged
shimat merged 4 commits into
mainfrom
agent/migrate-wiki-content
Jul 25, 2026
Merged

Migrate and expand OpenCvSharp usage guides#2090
shimat merged 4 commits into
mainfrom
agent/migrate-wiki-content

Conversation

@shimat

@shimat shimat commented Jul 25, 2026

Copy link
Copy Markdown
Owner

Migrates the useful parts of the stale Wiki into maintained DocFX guides. Pixel access, image conversion, video I/O, file storage, and histograms are rewritten for OpenCvSharp5, while the old per-algorithm feature pages are consolidated into one feature detection and matching guide.

Adds new task-oriented guides for Mat fundamentals and a complete image-processing pipeline. Obsolete platform tutorials, the removed debugger visualizer, and small DFT, Subdiv2D, and equation snippets are intentionally not copied because they are outdated or provide little OpenCvSharp-specific guidance. The repository instructions now also record the Label and assignee convention for agent-created PRs and issues.

Test plan

  • Compile all new guide examples against the current OpenCvSharp project with zero warnings and errors
  • Build the complete site with DocFX 2.78.5
  • Check generated HTML for broken local links
  • Run git diff --check

Summary by CodeRabbit

  • Documentation
    • Added new beginner-friendly guides for Mat Basics, Pixel Access, Image Processing Pipeline, Histograms and Contrast, Image Encoding and Conversion, Video I/O, Feature Detection and Matching, and File Storage.
    • Expanded the docs index and table of contents with a Common tasks section linking to the new guides.
    • Included practical, example-driven tips on validation, resource management, performance considerations, and common pitfalls.

@shimat shimat self-assigned this Jul 25, 2026
@shimat shimat added the enhancement New feature or improvement to OpenCvSharp label Jul 25, 2026
@shimat
shimat marked this pull request as ready for review July 25, 2026 21:52
@coderabbitai

coderabbitai Bot commented Jul 25, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro Plus

Run ID: b1e61065-47fd-4e56-a2fa-1a8c2f450904

📥 Commits

Reviewing files that changed from the base of the PR and between 9087611 and 741c417.

📒 Files selected for processing (2)
  • docs/docfx/articles/guides/pixel-access.md
  • docs/docfx/articles/guides/video-io.md
🚧 Files skipped from review as they are similar to previous changes (2)
  • docs/docfx/articles/guides/pixel-access.md
  • docs/docfx/articles/guides/video-io.md

📝 Walkthrough

Walkthrough

Added eight OpenCvSharp documentation guides, expanded DocFX navigation, and updated Copilot instructions for GitHub issue and pull request labels, assignees, and verification.

Changes

OpenCvSharp documentation guides

Layer / File(s) Summary
Mat fundamentals and pixel access
docs/docfx/articles/guides/mat-basics.md, docs/docfx/articles/guides/pixel-access.md
Documents Mat structure, ownership, conversions, wrapped data, and pixel access patterns.
Image processing and contrast workflows
docs/docfx/articles/guides/image-processing-pipeline.md, docs/docfx/articles/guides/histograms-and-contrast.md, docs/docfx/articles/guides/image-conversion.md
Adds examples for processing pipelines, histogram analysis, contrast enhancement, image encoding, and UI conversions.
Media, feature matching, and file storage
docs/docfx/articles/guides/video-io.md, docs/docfx/articles/guides/feature-detection-and-matching.md, docs/docfx/articles/guides/file-storage.md
Adds guidance for video I/O, feature matching, and YAML/XML/JSON matrix storage.
Documentation navigation
docs/docfx/articles/index.md, docs/docfx/articles/toc.yml, docs/docfx/index.md
Adds the new guides to DocFX indexes, common-task lists, and the table of contents.

Agent workflow instructions

Layer / File(s) Summary
Issue and pull request metadata rules
.github/copilot-instructions.md
Requires agents to inspect and verify labels, assign pull requests, and report when no suitable label exists.

Estimated code review effort: 3 (Moderate) | ~20 minutes

Possibly related PRs

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly reflects the main change: migrating existing OpenCvSharp usage guides into DocFX and expanding them with new guides.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch agent/migrate-wiki-content

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.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Actionable comments posted: 2

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@docs/docfx/articles/guides/pixel-access.md`:
- Around line 68-73: Add a grayscale Mat declaration directly in the RowSpan
example before accessing grayscale.RowSpan<byte>(0), using a single-channel type
such as CV_8UC1 and dimensions appropriate for the snippet. Keep the existing
first-row access and fill operations unchanged.

In `@docs/docfx/articles/guides/video-io.md`:
- Around line 67-80: Update the video-writing flow to read and validate the
first frame before constructing VideoWriter; derive frameSize from that frame’s
Width and Height, write the first frame, then continue reading and writing
subsequent frames without dropping it.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro Plus

Run ID: 91ec063c-3222-40f0-85e8-48b65a2e012e

📥 Commits

Reviewing files that changed from the base of the PR and between 972610f and 9087611.

📒 Files selected for processing (12)
  • .github/copilot-instructions.md
  • docs/docfx/articles/guides/feature-detection-and-matching.md
  • docs/docfx/articles/guides/file-storage.md
  • docs/docfx/articles/guides/histograms-and-contrast.md
  • docs/docfx/articles/guides/image-conversion.md
  • docs/docfx/articles/guides/image-processing-pipeline.md
  • docs/docfx/articles/guides/mat-basics.md
  • docs/docfx/articles/guides/pixel-access.md
  • docs/docfx/articles/guides/video-io.md
  • docs/docfx/articles/index.md
  • docs/docfx/articles/toc.yml
  • docs/docfx/index.md

Comment thread docs/docfx/articles/guides/pixel-access.md
Comment thread docs/docfx/articles/guides/video-io.md
@shimat
shimat merged commit 350f1f0 into main Jul 25, 2026
13 checks passed
@shimat
shimat deleted the agent/migrate-wiki-content branch July 25, 2026 22:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement New feature or improvement to OpenCvSharp

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant