docs(readme): reposition around "Make your product queryable" - #47
docs(readme): reposition around "Make your product queryable"#47Asaf-prog wants to merge 1 commit into
Conversation
|
|
|
|
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>
0340d80 to
dd4ca69
Compare
| </picture> | ||
| </p> | ||
|
|
||
| <h1 align="center">Make your product queryable.</h1> |
There was a problem hiding this comment.
wdyt "An AI that actually uses your product"
There was a problem hiding this comment.
I don't really like the queryable
| get tools, MCP servers, authentication, provider connectors, and | ||
| observability out of the box — so your app can be agentic in a day, not a | ||
| quarter. | ||
| Define the system in YAML. Extra handles routing, orchestration, and access |
There was a problem hiding this comment.
Define the system in YAML ->
Maybe Deploy agentic system in YAML?
| A2 --> RESP | ||
| A3 --> RESP | ||
| ``` | ||
| **Avoid model lock-in.** Switch model providers through configuration rather |
There was a problem hiding this comment.
please remove Avoid model lock-in from here too much details and not really neccesery
| Each agent only sees its own tools and data, so the model stays focused and | ||
| answers correctly for that part of your business. Add a new capability by | ||
| adding an agent to the file — no routing code to write. | ||
| **Embed it in your product.** Serve the system as an API or as an embeddable |
There was a problem hiding this comment.
WDYT
Adding it in your product. Embed the system as a widget chat or serve by an API
| boundaries while your logic and credentials stay in your backend. | ||
|
|
||
| ## How it works | ||
| ## Why Extra |
There was a problem hiding this comment.
I think you should add it also at the end
about that extra is fast accurance and using graph models design which is best performance with answers and accuracy.. just something like that
| description: "Routes each request to the right department." | ||
| prompts: | ||
| orchestrator: "prompts/router.md" | ||
| system: |
There was a problem hiding this comment.
lets do example with orchestrator so we can see value?
| That's the whole system. Extra validates it, compiles it, and serves it as an | ||
| API. You only write your own business logic — the tool and connector stubs | ||
| Extra generates for you. | ||
| Write the prompt it references, in `prompts/support.md`: |
There was a problem hiding this comment.
not good, need to run generate before
| ghcr.io/extra-org/extra:latest generate --config agents.yml | ||
|
|
||
| # Serve your system | ||
| docker run -p 8090:8090 -v "$(pwd):/workspace" -w /workspace \ |
There was a problem hiding this comment.
why not run it with our command for agent manger so can use playground ui widget or via curl also
| ``` | ||
|
|
||
| Install for Claude Code: | ||
| Your system is live at `http://localhost:8090` — send it a message with |
There was a problem hiding this comment.
lets add exact like no playground, or exac curl command with like
"Tell me about my system"
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:
generatefrom the critical path — a spec with no tools runs as-is — and leads withchatfor the fastest first conversation. Verified: minimal spec validates, serves, and chats with no plugins/ directory.agentctl chatoutput, the/invokeresponse shape, and the widget embed.