docs: refresh README, restore CHANGELOG Unreleased, tick ROADMAP#15
Closed
dmartinochoa wants to merge 1 commit into
Closed
docs: refresh README, restore CHANGELOG Unreleased, tick ROADMAP#15dmartinochoa wants to merge 1 commit into
dmartinochoa wants to merge 1 commit into
Conversation
Documentation pass consolidating everything across PRs #11-14 into a coherent story for v0.2.0. No code changes; lint, compile, tests, smoke all green. README.md: - New "Features" section above "What it scans" highlighting the surfaces that have landed: inline diagnostics, Findings panel, status bar item, CodeLens summary, keyboard navigation, tunable signal (severityThreshold + disabledProviders). - "Configuration" table gains pipelineCheck.disabledProviders and notes the machine-overridable scope on serverCommand/serverArgs. - New "Commands and keybindings" reference table. - New "Workspace trust" section documenting the limited-trust declaration and the machine-overridable rationale. - "Development" script list expanded to cover test, test:integration, smoke, lint. - "Releasing" section gains the vX.Y.Z-rc.N pre-release convention, the `production` GitHub Environment gate, and the three-OS CI matrix description. - Screenshot HTML comment updated to call out the four shots we want (inline / findings-panel / hover / status-bar). - New "Security" pointer to SECURITY.md. CHANGELOG.md: - Restored ## [Unreleased] block at the top. - Documented all the in-flight work for v0.2.0 under Added / Changed / Fixed, with R-tag cross-references to the roadmap. - Added a callout for the awk release-note extractor's first-`## [`-to-second behaviour, so future release commits don't accidentally ship the Unreleased boilerplate. ROADMAP.md: - "Status snapshot" table at the top mapping v0.1.0/v0.1.1/v0.2.0 state to closed item counts. - 19 of 29 R items ticked with PR cross-references (#11-#14). - Outstanding maintainer action items reorganised: stale v0.1.0-era items removed; current blockers (CodeQL setup, PVR/Discussions toggles, H4 manual smoke, screenshots) called out explicitly. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
|
Important Review skippedAuto reviews are disabled on base/target branches other than the default branch. Please check the settings in the CodeRabbit UI or the ⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
Merged
7 tasks
Member
Author
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
Documentation pass that consolidates everything from PRs #11–14 into a coherent story for v0.2.0. Stacked on #14, no code changes. lint / compile / tests / smoke all green.
What changed
README.md
CHANGELOG.md
ROADMAP.md
Test plan
Notes on release flow
When you cut v0.2.0, the release commit needs to:
The CHANGELOG-fold check in publish.yml will refuse the tag otherwise.
🤖 Generated with Claude Code