docs: fix README + CLAUDE.md facts not covered by #309#312
Merged
Conversation
Collaborator
|
👋 Heads-up — Code review queue is at 41 / 30 Above the WIP limit. The team convention is to review existing PRs before opening new work. Open PRs currently in Code review (oldest first):
Pull from review before opening new work. (This is a nudge from the kanban WIP check, not a block.) |
#309 (merged) already corrected the Python floor, added token_classification, and rewrote the custom-processor example. This adds the remaining stale facts it didn't touch: - Readme.md: BaseProcessor -> BaseIngestor (no BaseProcessor class exists); list run_ingestion + Config in the exports sentence - CLAUDE.md: Python 3.8+ -> 3.11+; dev install via requirements-dev.txt (runtime/dev requirements split, #246) Refs #311 Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
74ca4b4 to
258a377
Compare
shujaatTracebloc
approved these changes
Jun 18, 2026
7 tasks
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.
Summary
Follow-on to #309 (merged), which corrected the README's Python floor, added
token_classification, and rewrote the custom-processor example for v0.4.0. I'd independently audited the README and fixed the same items — this PR is now trimmed to only the stale facts #309 did not touch:Readme.mdBaseProcessor→BaseIngestor(line 99) — there is noBaseProcessorclass.run_ingestion+Config— consistent with the example docs(readme): correct stale facts after the v0.4.0 refactor #309 added (which imports both).CLAUDE.md(not touched by #309)Python 3.8+→3.11+(matchessetup.pypython_requires=">=3.11").requirements.txt→requirements-dev.txt— the runtime/dev split landed in refactor(packaging): split runtime vs dev requirements; declare numpy #246, sorequirements.txtis runtime-only.Test plan
Docs-only. Verified
BaseIngestor/run_ingestion/Configare top-level exports (__all__), andrequirements-dev.txtpulls in runtime via-r requirements.txt.Closes #311
🤖 Generated with Claude Code