Skip to content

docs: restructure index page and add results page - #154

Merged
visahak merged 1 commit into
AgentToolkit:mainfrom
vinodmut:docs
Apr 6, 2026
Merged

docs: restructure index page and add results page#154
visahak merged 1 commit into
AgentToolkit:mainfrom
vinodmut:docs

Conversation

@vinodmut

@vinodmut vinodmut commented Apr 6, 2026

Copy link
Copy Markdown
Contributor

Reorganize the landing page to lead with value proposition and streamlined getting started links. Add results page with AppWorld benchmark data and paper reference.

For #140

Summary by CodeRabbit

  • Documentation
    • Reorganized homepage to emphasize session-to-session memory benefits and reduction of repeated agent errors
    • Added "How It Works" section explaining core system functionality and implementation approaches
    • Published comprehensive benchmark results showing measurable performance improvements across task difficulty levels
    • Updated navigation structure with new Results section and interactive Hello World tutorials

Reorganize the landing page to lead with value proposition and streamlined
getting started links. Add results page with AppWorld benchmark data and
paper reference.
@coderabbitai

coderabbitai Bot commented Apr 6, 2026

Copy link
Copy Markdown

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: a5d6794e-2669-43f1-aa0c-e9d728a6256c

📥 Commits

Reviewing files that changed from the base of the PR and between 4ed2be1 and 1f2146e.

📒 Files selected for processing (3)
  • docs/index.md
  • docs/results/index.md
  • mkdocs.yaml

📝 Walkthrough

Walkthrough

The documentation landing page was restructured to emphasize session-to-session memory benefits. A new benchmark results page documenting AppWorld Benchmark performance was added. Navigation configuration was updated to include the Results section and renamed the Getting Started section with Hello World examples.

Changes

Cohort / File(s) Summary
Documentation Landing Page
docs/index.md
Refocused introduction on session-to-session memory reducing agent errors; removed Features section; added How It Works section describing trajectory-to-guideline extraction and both Evolve Lite (file-based) and full (MCP + vector storage + LLM) modes; renamed "Start Here" to "Get Started" with Hello World example links.
Benchmark Results Page
docs/results/index.md
New documentation page presenting AppWorld Benchmark results including evaluation setup, Scenario Goal Completion metrics, difficulty breakdown table, key findings on generalization and performance gains, and arXiv paper reference.
Navigation Configuration
mkdocs.yaml
Added new top-level Results section under Tutorials with Benchmarks link to the new results documentation page.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

  • PR #153: Overlaps in updating docs navigation and docs/index.md with link changes to Hello World and Evolve Lite, plus mkdocs.yaml modifications.
  • PR #131: Related through shared documentation structure edits to docs/index.md and mkdocs.yaml navigation configuration.

Suggested reviewers

  • gaodan-fang
  • illeatmyhat

Poem

🐰 Hop through the docs, see memories grow,
Trajectories guide where agents should go,
Benchmarks shine bright on the AppWorld stage,
Evolve Lite and full dance across the page! 📊✨

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title directly and accurately summarizes the main changes: restructuring the index page and adding a results page, which aligns with the file modifications in docs/index.md, docs/results/index.md, and mkdocs.yaml.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@vinodmut vinodmut mentioned this pull request Apr 6, 2026
7 tasks
@visahak
visahak self-requested a review April 6, 2026 17:55

@visahak visahak left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@visahak

visahak commented Apr 6, 2026

Copy link
Copy Markdown
Collaborator

@illeatmyhat we may need to rebuild the docs.

@visahak
visahak merged commit 41b8cc1 into AgentToolkit:main Apr 6, 2026
16 checks passed
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.

2 participants