docs(readme): reposition around the vision — one attribute, one protocol#360
Merged
Conversation
- Tagline: 'Give your LLM eyes. One attribute for humans, one protocol for agents.' - MCP section now leads with the one-command npx askable-mcp stdio setup for Claude Desktop/Cursor (shipped in #349), with the in-process and web-handler paths as secondary; documents list_context_sources and askable://current - New 'An open protocol, not just a library' section introducing the Context Packet wire format with a link to the spec page - Fix invalid Angular useAskableCompose sample (README + source JSDoc): class bodies cannot destructure; use a field initializer - Refresh stale availability claims (viewport/history now cover Solid/Angular/ Qwik) and the Qwik package row (15+ hooks after the expansion)
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
@askable-ui/angular
@askable-ui/context
@askable-ui/core
@askable-ui/create-app
@askable-ui/mcp
@askable-ui/qwik
@askable-ui/react
@askable-ui/react-native
@askable-ui/solid
@askable-ui/svelte
@askable-ui/vue
@askable-ui/web-component
commit: |
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.
Summary
Part 2 of the vision work: the README now tells one retellable story — "Give your LLM eyes. One attribute for humans, one protocol for agents." — and leads with the two most shareable capabilities (the one-command Claude Desktop setup and the open wire format) instead of burying them.
Changes
npx -y @askable-ui/mcp --url …stdio setup for Claude Desktop/Cursor (shipped in feat(mcp): add askable-mcp stdio CLI for command-based MCP clients #349) is now the first thing shown, with the in-process server and web handler as secondary paths. Documentslist_context_sourcesand the liveaskable://currentresource (shipped in feat(mcp): add live askable://current resource and list_context_sources tool #353), plus--require-redacted.askable.context/0.1) with a mini example and links to the spec page (docs: publish the Context Packet Protocol as a first-class spec page #359). Added to the header nav links.use-askable-compose.tsJSDoc):{ promptContext } = useAskableCompose(…)is not valid in a class body — replaced with the field-initializer formpromptContext = useAskableCompose(this.sections).promptContext;./docs/api/mcp→/docs/guide/mcp) is corrected.Test plan
🤖 Generated with Claude Code
Generated by Claude Code