Release-readiness audit: polish docs, clean repo, fix consistency#12
Merged
Merged
Conversation
- Overhaul README: add CI/PyPI/license badges, cross-platform install commands first, Windows guidance in collapsible details, tighter status section for v0.1.0 - Remove market research PDF and audit reports from repo (preserved in git history) - Fix cli.py hardcoded default models to import from backend modules, matching existing Ollama pattern - Create CHANGELOG.md for first release - Add py.typed marker (PEP 561) for downstream type checking - Update llms.txt with --context-file and other missing CLI flags - Update ROADMAP.md to mark completed community items - Tighten hatch build excludes for audit reports and changelog - Add *.pdf to .gitignore https://claude.ai/code/session_01H1AP8Drr8SE7QFevAookwL
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
2 participants
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.
https://claude.ai/code/session_01H1AP8Drr8SE7QFevAookwL
Summary
Describe the change in a few sentences.
Checklist
make release-checkpasses locallyNotes
Add any reviewer context, risks, or follow-up items here.