Skip to content

docs: link the design articles from the README and PyPI #21

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
CocoRoF wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: link the design articles from the README and PyPI #21

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -216,6 +216,20 @@ contextifier/
| [OCR Guide](docs/ocr_guide.md) | OCR engine setup & customization |
| [Plugin Development](docs/plugin_development.md) | Custom handler development guide |

## Articles

Design notes and deep dives on how Contextifier works, from the author's blog ([hrletsgo.me](https://hrletsgo.me/en)).

| Article | Korean |
|---|---|
| [Contextifier: Converting Documents into AI-Ready Text Chunks](https://hrletsgo.me/en/documents/contextifier-document-processing-rag-pipeline) | [한국어](https://hrletsgo.me/documents/contextifier-document-processing-library) |
| [Contextifier PDF Handler: Table Detection and Text Quality Analysis](https://hrletsgo.me/en/documents/contextifier-pdf-handler-table-detection-text-quality) | [한국어](https://hrletsgo.me/documents/contextifier-pdf-handler-deep-dive) |
| [Contextifier HWP/HWPX Processor: Parsing Korean Documents](https://hrletsgo.me/en/documents/contextifier-hwp-hwpx-document-parsing) | [한국어](https://hrletsgo.me/documents/contextifier-hwp-hwpx-handler) |
| [Contextifier RTF/DOCX Handler: Streaming Table Processing](https://hrletsgo.me/en/documents/contextifier-rtf-docx-streaming-table-processing) | [한국어](https://hrletsgo.me/documents/contextifier-rtf-docx-streaming-tables) |
| [Contextifier Chunking Strategies for Meaningful Document Splits](https://hrletsgo.me/en/documents/contextifier-chunking-strategies-rag-documents) | [한국어](https://hrletsgo.me/documents/contextifier-chunking-strategy) |
| [Contextifier OCR: Building a Multi-Provider OCR Engine](https://hrletsgo.me/en/documents/multi-provider-ocr-engine-llm-vision) | [한국어](https://hrletsgo.me/documents/contextifier-ocr-engine-module) |
| [Publishing Contextifier to PyPI](https://hrletsgo.me/en/documents/publishing-contextifier-to-pypi) | [한국어](https://hrletsgo.me/documents/contextifier-pypi-publish) |

## License

Apache License 2.0 — see [LICENSE](LICENSE)
Expand Down
1 change: 1 addition & 0 deletions pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -101,6 +101,7 @@ Documentation = "https://github.com/CocoRoF/Contextifier#readme"
Repository = "https://github.com/CocoRoF/Contextifier.git"
Issues = "https://github.com/CocoRoF/Contextifier/issues"
Changelog = "https://github.com/CocoRoF/Contextifier/releases"
Blog = "https://hrletsgo.me/en/documents/contextifier-document-processing-rag-pipeline"

[tool.hatch.build.targets.wheel]
packages = ["contextifier"]
Expand Down
Loading