Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

WIP: overhaul, prep comps, prep agent kit #47

Closed
wants to merge 9 commits into from

Conversation

andrewxhill
Copy link
Contributor

Screenshot 2025-04-01 at 11 01 57 PM

@dtbuchholz here is a pretty WIP overhaul. I think it's super promising though, it gives a really nice flow into the information and it feels like the right things are highlighted at the right time. It feels like there are three tasks here:

  • review accuracy of new stuff (agent toolkit, mcp). i tried to use some of the agent toolkit included examples, but hit snags so prob better for your eyes.
  • simplify and cut stuff that is TMI, not ready, no longer right.
  • open tix on enhancements we could make (tests, building off other package docs, etc)

Could you take a spin on this? I left some comments for mark below too, so maybe we can tap him in afterwards?

Overview

A WIP overhaul of docs. Brings them up to speed with competition role and framing. Makes beginner uses the primary focus, since every user is a beginner on recall right now.

  • Quickstart and Framework guides that focus on 0-something very quickly
  • MCP at the forefront along with agent toolkit.
  • Move deeper tech down below
  • Adds places for competition info to go public already, including trading sim.

Notes below.

Agent toolkit

@dtbuchholz to review and simplify any here:

  • docs/agent-toolkit/*

MCP

@dtbuchholz to review and simplify any here:

  • `docs/mcp-integration/*

Frameworks plugin

@dtbuchholz to review and simplify any here:

  • docs/framework-guides/index.json
  • docs/framework-guides/ai-sdk.json
  • docs/framework-guides/openai.json
  • docs/framework-guides/langchain.json

@mzkrasner to review and simplify any here:

  • docs/framework-guides/eliza.json

@andrewxhill to final review

  • docs/framework-guides/mastra.json

Competitions

@mzkrasner please review these, any simplifications/improvements.

  • `docs/competitions/*

Maybe get carson and or kristal's eyes on these pages at some point before merge too

Trading sim

@mzkrasner please review these, any simplifications/improvements.

  • `docs/trading-simulator/*

Advanced development

This is old content, is any of it still useful?

  • docs/agents/plugins/eliza/cot.mdx
  • docs/agents/plugins/eliza/index.mdx
  • docs/agents/plugins/eliza/s3.mdx
  • docs/agents/plugins/eliza/meta.json
  • docs/agents/access.mdx
  • docs/agents/index.mdx
  • docs/agents/meta.json

Copy link

vercel bot commented Apr 2, 2025

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
docs ❌ Failed (Inspect) Apr 2, 2025 6:17am

@andrewxhill andrewxhill requested a review from dtbuchholz April 3, 2025 00:17
@dtbuchholz
Copy link
Collaborator

@mzkrasner btw, i can do a first pass at all of the trading sim / other tools you're building since i've been a consumer of them. so i can tag you thereafter for a final pass.

@rohhan
Copy link

rohhan commented Apr 4, 2025

@andrewxhill

  1. I think we received some feedback from Danny and others that "credibly neutral" hasn't historically landed or done well with audiences, so we should move away from that language. It also might not be fully accurate/raise unnecessary questions in early phases (and maybe not even in later phases if we explore subjective competitions). How do you feel about removing that type of language?
  2. Would it make more sense to push the Competition Schedule page a bit later once we have more details?
  3. IMO we should wait to publish the "Evaluation metrics" section until we have more clarity internally cc @KGmajor

@andrewxhill
Copy link
Contributor Author

@rohhan

I think we received some feedback from Danny and others that "credibly neutral" hasn't historically landed or done well with audiences, so we should move away from that language. It also might not be fully accurate/raise unnecessary questions in early phases (and maybe not even in later phases if we explore subjective competitions). How do you feel about removing that type of language?

go for it, what's the edit you recommend?

Would it make more sense to push the Competition Schedule page a bit later once we have more details?

Yes, that was my thinking. I wanted to have it drafted, designed in flow wise, and nearly there so that we could touch it up and make it live as soon as we are ready. Versus getting stuck doing another doc overhaul in a week.

IMO we should wait to publish the "Evaluation metrics" section until we have more clarity internally cc @KGmajor

I'd include that in the bucket above, we can remove it from production before we publish. Could you give us a docs timeline here/in notion so we know when these elements should be rolled out?

@dtbuchholz
Copy link
Collaborator

Could you give us a docs timeline here/in notion so we know when these elements should be rolled out?

I'll have this stuff ready for Monday. Assuming ppl want to give it a final review thereafter, probably Tues/Weds?

@andrewxhill
Copy link
Contributor Author

andrewxhill commented Apr 5, 2025 via email

@dtbuchholz
Copy link
Collaborator

Ooh i misread that ha.

Yeah fwiw, it'd be nice if we rolled out the updates all at once...it's less rework for removing/adding back links to competition pages and whatnot. But only if the competition timelines aren't too far out. Otherwise, nbd.

@dtbuchholz
Copy link
Collaborator

closing as #48 incorporates this work

@dtbuchholz dtbuchholz closed this Apr 8, 2025
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.

3 participants