Repository navigation
v2.3.1 — Documentation Audit & Accuracy Fix
Overview
This release focuses on documentation accuracy and consistency. We've conducted a comprehensive audit of all user-facing documentation and corrected discrepancies between docs and the actual codebase implementation.
🔧 What's Fixed
Documentation Corrections
- Fixed npm package name: Corrected
url-to-markdown-cli→url-to-markdown-cli-toolacross all installation docs (SETUP.md, README.md) - Added missing module references: Documented
urltomd_fetcher.py,jina_fetcher.py, andmarkdown_cleanup.pyin repository structure - Documented
run_workflow.sh: Added usage guide for the sequential workflow script as alternative to parallel CLI processing - Removed dead references: Eliminated reference to non-existent PRD file
Architecture Documentation Updates
- Updated workflow diagram to reflect current
url-to-md+Jinafallback strategy (replaced Playwright references) - Updated deployment docs to reference
url-to-md/Jinainstead of Playwright for Cloudflare bypass - Updated troubleshooting guide to reflect current tooling and dependencies
Code Cleanup
- Deleted obsolete test scripts referencing removed Playwright dependency:
scripts/debug-playwright-headed.pyscripts/test-jina-cli.shscripts/test-jina-feasibility.pyscripts/test-jina-real-articles.pyscripts/test-playwright-comparison.py
📋 Changes
Files Modified:
- CLAUDE.md
- README.md
- docs/SETUP.md
- docs/TROUBLESHOOTING.md
- docs/workflow-diagram.mmd
- AGENTS.md
- Summarizer/deploy/README.md
Files Deleted: 5 obsolete test scripts
✅ Benefits
- Accurate onboarding: Users get the correct npm package name on first install
- Complete module reference: Developers can now find all pipeline modules documented
- Current architecture: Documentation accurately reflects url-to-md + Jina fallback strategy (not Playwright)
- Reduced confusion: Removed dead PRD references and obsolete test scripts
📝 Notes for Users
- No code changes—documentation only
- Ensure you have
url-to-markdown-cli-toolinstalled (noturl-to-markdown-cli) for Cloudflare-protected sites run_workflow.shis available as an alternative topython3 -m Summarizer.cli runfor sequential processing