docs: add C4 architecture documentation with diagrams and README #1401
Conversation
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
- Level 1 (System Context): Overview of MarkItDown in the ecosystem, showing interaction with users and external tools. - Level 2 (Containers): Breakdown into main components — CLI, Conversion Orchestrator, Converters, and Stream Info. - Level 3 (Components): Deep dive into Conversion Orchestrator (_markitdown.py), including phases, dependencies, and control flow. - Level 4 (Code-level): Detailed design of DocumentConverter hierarchy, exception handling, and converter registry. Diagrams included as editable sources (.drawio, .puml) and exported PNGs: - C4-Diagrams/src/ – editable files - C4-Diagrams/exports/ – rendered images Improves onboarding, documentation, and long-term maintainability.
|
@microsoft-github-policy-service agree |
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.
Adds comprehensive C4 architecture documentation for MarkItDown CLI
What's Changed
.drawio,.puml) and exported PNGssrc/andexports/directoriesREADME.mdexplaining each diagram level and system componentsWhy
To improve documentation and onboarding for contributors by providing clear, visual architecture overviews. The C4 model helps new developers understand:
How