Skip to content

docs(readme): reposition around "Make your product queryable" - #47

Open
Asaf-prog wants to merge 1 commit into
mainfrom
feature/readme-product-positioning
Open

docs(readme): reposition around "Make your product queryable"#47
Asaf-prog wants to merge 1 commit into
mainfrom
feature/readme-product-positioning

Conversation

@Asaf-prog

Copy link
Copy Markdown
Collaborator

Rewrite the README to lead with the product outcome instead of the framework. The hero now answers what problem Extra solves, why it matters, and how to try it, before any implementation detail.

Changes:

  • New hero: "Make your product queryable" — add a secure AI interface to an existing product, reusing the APIs and business logic you have.
  • Restructure to Hero → Demo → Why Extra → Quick Start → Example YAML → Features → Architecture → Use cases → Contributing.
  • "Why Extra" now states developer outcomes (ship faster, reuse your backend, authorization outside the LLM, model agnostic, embeddable) rather than listing technical primitives.
  • Quick Start drops generate from the critical path — a spec with no tools runs as-is — and leads with chat for the fastest first conversation. Verified: minimal spec validates, serves, and chats with no plugins/ directory.
  • Add "Who is Extra for?" and "When Extra is probably unnecessary".
  • Add a Demo section: real agentctl chat output, the /invoke response shape, and the widget embed.
  • Fix the invoke payload: the API takes {"message": "..."}, not {"messages": [...]} as the old README showed.
  • Collapse the agent-setup skill install steps into a details block.

@Asaf-prog
Asaf-prog requested a review from AmitAvital1 July 25, 2026 15:42
@Asaf-prog Asaf-prog self-assigned this Jul 25, 2026
@Asaf-prog

Copy link
Copy Markdown
Collaborator Author
image

@Asaf-prog

Copy link
Copy Markdown
Collaborator Author
image

@Asaf-prog

Copy link
Copy Markdown
Collaborator Author
image

@Asaf-prog

Copy link
Copy Markdown
Collaborator Author
image

Lead with the product outcome — "Make your product queryable" — instead of
the framework, then cut the README to what a developer needs to decide
whether Extra is relevant before moving into the docs.

- Restructure to Hero → Why Extra → Quick Start → Features → Architecture
  → Who it's for → Contributing.
- State developer outcomes rather than listing primitives.
- Quick Start is the smallest genuinely runnable system: one agent, no
  orchestrator, one prompt file, one command. Verified end-to-end.
- Move advanced onboarding to documentation links: generate/stub workflow,
  MCP setup, agent-manager, conversation history, widget install,
  non-Docker setup, and the extra-setup coding-agent skill.
- Fix the invoke payload: the API takes {"message": "..."}.
- Keep security wording precise — the model cannot grant itself access to
  protected capabilities, since denied nodes are removed from the router's
  options.

Co-Authored-By: Claude <noreply@anthropic.com>
@Asaf-prog
Asaf-prog force-pushed the feature/readme-product-positioning branch from 0340d80 to dd4ca69 Compare July 25, 2026 15:56
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