Improve README with expanded usage, feature highlights, and API surface#8
Merged
Merged
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
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.
Motivation
README.mdmore useful for new users by surfacing key capabilities and common workflows.Description
What You Getsection summarizing structure-safety, metadata, strategies, hierarchy and streaming.code-context binding,adaptive sizing,table grouping, andstrip_obsidian_block_idsand linked to the relevant docs.analyze_markdownandchunk_with_metrics, plus an advanced configuration snippet demonstratingChunkConfig,AdaptiveSizeConfig, andTableGroupingConfig.Core API Surfacelist with primary convenience functions such aschunk_markdown,chunk_hierarchical,chunk_file/chunk_file_streaming,analyze_markdown,chunk_with_metrics, anditer_chunksinREADME.md.Testing
README.md(documentation only).Codex Task