Skip to content

docs(readme): correct stale facts after the v0.4.0 refactor#309

Merged
shujaatTracebloc merged 1 commit into
developfrom
docs/readme-v0.4-accuracy
Jun 18, 2026
Merged

docs(readme): correct stale facts after the v0.4.0 refactor#309
shujaatTracebloc merged 1 commit into
developfrom
docs/readme-v0.4-accuracy

Conversation

@LukasWodka

Copy link
Copy Markdown
Collaborator

Summary

Three accuracy fixes to the public README, found reviewing it against the shipped v0.4.0. The README's core (the declarative-YAML path, helm flow, metadata-only sync) is current — the refactor was internal and behavior-preserving, so no architecture rewrite is needed. These are stale facts only:

  1. Python floor 3.8+ → 3.11+ — the badge and Prerequisites now match setup.py (python_requires=">=3.11", bumped in the P1 packaging phase).
  2. Add token_classification to the supported-types table — it's the 11th template (templates/token_classification/) but was missing from the Text/NLP row.
  3. Fix the custom-processor example — the old "Subclassing BaseIngestor" snippet showed a validators = [...] class attribute, a transform() hook, and MyIngestor().ingest() that don't exist. Replaced with the real instantiation pattern (CSVIngestor(database=, api_client=, category=, …) + run_ingestion(...)), matching the templates/ scripts and the package's top-level exports.

Type

Docs.

Test plan

Docs-only; no code change. The new example was verified against templates/image_classification/image_classification.py and tracebloc_ingestor/__init__.py exports.

🤖 Generated with Claude Code

- Python floor 3.8+ -> 3.11+ (matches setup.py python_requires)
- add token_classification to the supported-types table (11th template)
- replace the fictional BaseIngestor subclassing snippet (validators/transform
  class API that does not exist) with the real CSVIngestor + run_ingestion pattern

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@LukasWodka

Copy link
Copy Markdown
Collaborator Author

👋 Heads-up — Code review queue is at 39 / 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.)

@shujaatTracebloc shujaatTracebloc merged commit c6bc6ad into develop Jun 18, 2026
6 checks passed
@shujaatTracebloc shujaatTracebloc deleted the docs/readme-v0.4-accuracy branch June 18, 2026 06:28
saadqbal added a commit that referenced this pull request Jun 18, 2026
#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>
saadqbal added a commit that referenced this pull request Jun 18, 2026
docs: fix README + CLAUDE.md facts not covered by #309
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants