Skip to content

Revamp README and expand documentation (badges, examples, integrations)#1

Merged
asukhodko merged 1 commit into
mainfrom
codex/improve-readme-and-documentation
Jan 8, 2026
Merged

Revamp README and expand documentation (badges, examples, integrations)#1
asukhodko merged 1 commit into
mainfrom
codex/improve-readme-and-documentation

Conversation

@asukhodko

Copy link
Copy Markdown
Owner

Motivation

  • Prepare the project for PyPI/consumer discovery by adding repository and PyPI badges and stronger SEO-friendly copy to the README.
  • Make the library’s purpose and benefits clearer and more “product-led” for users seeking a semantic Markdown chunker for RAG/LLM workflows.
  • Provide more usage examples and integration guidance to ease migration from the previous plugin and to show common workflows.

Description

  • Reworked README.md: added GitHub/PyPI/license/download badges, stronger marketing/SEO description, reorganized sections, and expanded usage examples and presets.
  • Added docs/overview.md and updated docs under docs/ including quickstart.md, config.md, strategies.md, renderers.md, debug_mode.md, and integration guides for Dify, n8n, and Windmill with concrete code snippets.
  • Clarified hierarchical chunking and renderer usage, added recommended ChunkerConfig presets and adaptive sizing example, and documented Dify migration mappings and parity test commands.

Testing

  • No automated tests were executed because this is a documentation-only change.
  • Baseline/compatibility test commands are documented for users to run: pytest tests/baseline/test_canonical.py -v and pytest tests/baseline/test_view_level.py -v.

Codex Task

@asukhodko asukhodko merged commit 57631fc into main Jan 8, 2026
1 check passed
@asukhodko asukhodko deleted the codex/improve-readme-and-documentation branch January 8, 2026 20:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant