Skip to content

docs: reflect 1.0 release + new peek/get_issues capabilities - #34

Merged
tamimbinhakim merged 1 commit into
mainfrom
docs/v1-public-readiness
Jun 5, 2026
Merged

docs: reflect 1.0 release + new peek/get_issues capabilities#34
tamimbinhakim merged 1 commit into
mainfrom
docs/v1-public-readiness

Conversation

@tamimbinhakim

Copy link
Copy Markdown
Collaborator

Documentation pass now that ctxpeek 1.0.0 is published — gets the docs aligned for people discovering the project fresh. Docs-only, no changeset (won't trigger a republish).

  • README roadmap: marks v1.0 shipped (links npm), notes the tool schema is now under semver, folds in-file grep (peek) and issue/PR filtering + single-item reads (get_issues) into the baseline, and drops the completed "v1 readiness" backlog row.
  • getting-started guide: adds a "grep a file, or read an issue" step demonstrating peek with a query and get_issues with filters + number read-one.
  • root CHANGELOG: replaces the stale "Unreleased / initial scaffold" note with the 1.0.0 entry, linking the package changelog and the GitHub release.

The tool reference (docs/reference/tools.md), README tool list, and architecture.md were already updated in the 1.0 feature PR (#32).

🤖 Generated with Claude Code

- README roadmap: mark v1.0 shipped (on npm), note the tool schema is now
  under semver, add in-file grep + issue filtering/read-one to the baseline,
  drop the completed "v1 readiness" row
- getting-started: new "grep a file, or read an issue" step showing
  peek `query` and get_issues filters + read-one
- root CHANGELOG: replace stale Unreleased scaffold note with the 1.0.0 entry

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@tamimbinhakim
tamimbinhakim merged commit a010bc5 into main Jun 5, 2026
17 of 18 checks passed
@tamimbinhakim
tamimbinhakim deleted the docs/v1-public-readiness branch June 5, 2026 15:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant