Enhance README and improve error handling for Document Intelligence#1695
Open
dhruvgupta2109 wants to merge 5 commits intomicrosoft:mainfrom
Open
Enhance README and improve error handling for Document Intelligence#1695dhruvgupta2109 wants to merge 5 commits intomicrosoft:mainfrom
dhruvgupta2109 wants to merge 5 commits intomicrosoft:mainfrom
Conversation
|
@dhruvgupta2109 please read the following Contributor License Agreement(CLA). If you agree with the CLA, please reply with the following information.
Contributor License AgreementContribution License AgreementThis Contribution License Agreement (“Agreement”) is agreed to by the party signing below (“You”),
|
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.
This pull request improves the usability and documentation of the MarkItDown project, focusing on enhanced documentation for its multi-package ecosystem, clearer usage instructions, and improved CLI behavior and testing for stdin and Document Intelligence scenarios.
Documentation improvements:
README.mdto document all packages in the repository, their compatibility, and Python version support. Added a table summarizing each package and its requirements. [1] [2]README.mdto help users resolve common issues with plugins, optional dependencies, OCR, and MCP server deployment.CLI and core functionality:
__main__.pyto reject stdin (including-as filename) for Document Intelligence conversions, with a clear error message, while allowing stdin for standard conversions.Testing enhancements:
-works as expected and that Document Intelligence mode properly rejects stdin, improving reliability and preventing regressions.