Clarify plugin-first OCR extension docs#1651
Open
jimmyzhuu wants to merge 1 commit intomicrosoft:mainfrom
Open
Clarify plugin-first OCR extension docs#1651jimmyzhuu wants to merge 1 commit intomicrosoft:mainfrom
jimmyzhuu wants to merge 1 commit intomicrosoft:mainfrom
Conversation
Author
|
@microsoft-github-policy-service agree |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
This PR makes the plugin extension path clearer in the documentation, especially for OCR-related integrations.
It focuses on three small documentation improvements:
markitdown-ocrREADME so its usage guidance matches the current product surface more closelyregister_converters(markitdown, **kwargs)Problem
While exploring OCR extension paths, I found a few places where the current docs can be read as more permissive or more direct than the current implementation actually is:
markitdown-ocrREADME includes a CLI example that suggests the built-in CLI can fully configure an LLM client for the pluginMarkItDown(enable_plugins=True, **kwargs)These are small issues, but together they make it harder to understand how third-party OCR or backend-specific extensions should be integrated.
What this PR changes
Main README
Adds a short note in the Plugins section explaining that plugins are the recommended extension path when an extension:
packages/markitdown-ocr/README.mdllm_clientandllm_modelcan be passed directlypackages/markitdown-sample-plugin/README.mdAdds a short note that plugin authors can read optional configuration from
register_converters(markitdown, **kwargs).Non-goals
This PR does not:
Why this design
I kept this PR documentation-only to make the current extension model easier to understand without changing behavior.
Backward compatibility
No behavior changes. Documentation only.
Related context
Related discussion: #1650