docs: polish README and add CHANGELOG for v1.0#46
Merged
Conversation
Remove all stale "coming in vX.Y.Z" placeholders from README. Add working CLI quickstart, Python API example, exposure modes and difficulty profiles documentation, output bundle layout, and key design principles. Create CHANGELOG.md covering v0.1.0 through current state. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
This comment has been minimized.
This comment has been minimized.
There was a problem hiding this comment.
Pull request overview
Improves top-level documentation by updating the README quickstart/docs and introducing a project changelog to better communicate current capabilities and recent progress.
Changes:
- Expanded
README.mdwith working CLI/Python quickstart, exposure modes, difficulty profiles, bundle layout, and development commands. - Added
CHANGELOG.mdsummarizing milestones/feature additions from v0.1.0 through post-v0.5.0. - Updated
.agent-plan.mdto mark M15 documentation work as in progress/completed.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| README.md | Adds user-facing quickstart and conceptual docs (modes, difficulty, outputs, principles) and links to deeper docs. |
| CHANGELOG.md | Introduces a release-style history of features and milestones. |
| .agent-plan.md | Tracks completion status for the documentation milestone and updates deferred-items status. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
- Add Python 3.11+ requirement to Installation - Replace `pip install leadforge` with git install (no PyPI yet) - Expand bundle tree to show task subdirectory nesting - CHANGELOG: rename versions to "Milestone 0.x.0", add dates - CHANGELOG: fold post-v0.5.0 items into "Unreleased" section Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
|
pr-agent-context report: No unresolved review comments, failing checks, or actionable patch coverage gaps were found on PR #46 in repository https://github.com/leadforge-dev/leadforge. Treat this PR as all clear unless new signals appear.Run metadata: |
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
Test plan
🤖 Generated with Claude Code