docs: reflect the published v0.1.0 release#12
Merged
Conversation
The npm package, v0.1.0 tag, versioned GitHub Action, and GHCR demo image are all live, but the README and Action guide still carried pre-release "not published yet" notices and a clone-and-build quick start. Replace the quick start with the real npm install path, mark the Action as shipped, document the GHCR pull command, and update the Action guide's release status note. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01UxYFd1KhMHh7ZLytLz4Yg8
There was a problem hiding this comment.
Pull request overview
Updates the public-facing documentation to match the now-published contextfence@0.1.0 release, removing pre-release caveats and switching examples to use the published npm package, versioned GitHub Action, and GHCR image.
Changes:
- README quick start updated to install/run the published CLI and fetch example contracts from the
v0.1.0tag. - Capability table and GitHub Actions section updated to reflect the shipped exact-version Action.
- Container instructions updated to use the published
ghcr.io/devectorio/contextfence:0.1.0image; Action guide updated to “published” status guidance.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| README.md | Replaces pre-release notes with published-install quick start; updates capability/action/container sections for v0.1.0. |
| docs/github-action.md | Updates Action release-status note to reflect the published tag/package and adds pinning guidance. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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.
What this changes
The npm package (
contextfence@0.1.0), thev0.1.0tag, the versioned GitHub Action, and the GHCR demo image are all live — but the README and Action guide still carried pre-release "not published yet" notices and a clone-and-build quick start. Anyone arriving from a launch post would be told not to install a package that installs fine.npm install -g contextfence, fetch the example contract, run it (verified end-to-end:npx contextfence@0.1.0 --version→0.1.0).docker run ghcr.io/devectorio/contextfence:0.1.0(verified: GHCR lists0.1.0,0.1,latest).Evidence
dist-tags.latestis0.1.0;npm exec contextfence@0.1.0 -- contextfence --versionprints0.1.0.devectorio/contextfenceincludes0.1.0,0.1,latest.git ls-remote --tagsshowsv0.1.0.Verification
pnpm lintpnpm typecheckpnpm testpnpm buildrelease-checkpreflight green, which validates the README's required portable links.)Safety and compatibility
CHANGELOG.md. (Docs-only correction of stale release notices; no behavior change to log.)Screenshots or artifacts
N/A.
🤖 Generated with Claude Code
https://claude.ai/code/session_01UxYFd1KhMHh7ZLytLz4Yg8
Generated by Claude Code