Skip to content

docs: redesign the docs UI — dark-first, instrument-panel identity (#239) #242

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.

Sign up for GitHub

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

Merged
himanshu231204 merged 1 commit into from
Jul 24, 2026
Merged

docs: redesign the docs UI — dark-first, instrument-panel identity (#239) #242

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 3 additions & 9 deletions docs/assets/favicon.svg
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
12 changes: 3 additions & 9 deletions docs/assets/logo.svg
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
37 changes: 29 additions & 8 deletions docs/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,8 @@ hide:

<div class="oae-hero">
<div class="oae-hero__copy">
<span class="oae-badge">v0.1.0 · Local-first · Apache 2.0</span>
<h1>The pytest of AI evaluation</h1>
<span class="oae-badge">v0.1.0 · local-first · apache-2.0</span>
<h1>The pytest of AI <em>evaluation</em></h1>
<p class="oae-lede">
Open-source, local-first framework for evaluating RAG systems and AI agents.
A clean CLI, a typed Python SDK, and a pluggable metric &amp; provider architecture —
Expand All @@ -19,10 +19,22 @@ hide:
<a href="installation.md" class="md-button md-button--primary">Get Started</a>
<a href="https://github.com/OpenAgentHQ/openagent-eval" class="md-button">GitHub</a>
</div>
<div class="oae-install">pip install openagent-eval</div>
</div>
<div class="oae-hero__art">
<img src="assets/hero.svg" alt="OpenAgent Eval pipeline: config to engine to report" loading="lazy">
<div class="oae-terminal">
<div class="oae-terminal__bar">
<span class="oae-terminal__dot"></span>
<span class="oae-terminal__dot"></span>
<span class="oae-terminal__dot oae-terminal__dot--accent"></span>
<span class="oae-terminal__title">oaeval — zsh</span>
</div>
<div class="oae-terminal__body">
<p><span class="oae-prompt">$</span>pip install openagent-eval</p>
<p><span class="oae-prompt">$</span>oaeval init</p>
<p class="oae-out">wrote config.yaml</p>
<p><span class="oae-prompt">$</span>oaeval run config.yaml</p>
<p class="oae-out">12 cases · faithfulness, context_recall, latency</p>
<p class="oae-ok">report saved — faithfulness 0.87 · recall 0.92</p>
</div>
</div>
</div>

Expand Down Expand Up @@ -133,9 +145,18 @@ Metric names map to the built-in registry (`openagent_eval.metrics.METRIC_REGIST
<h2>Bring your own, or use what ships</h2>
</div>

| LLM Providers | Retriever Providers | Embedders |
| --- | --- | --- |
| OpenAI, Google Gemini, Anthropic, Groq, OpenRouter, Ollama, Mock | Chroma, Memory, BM25, FAISS, Qdrant, Pinecone, Weaviate, Elasticsearch, PGVector, HTTP, Mock | Sentence-Transformers, Mock |
<div class="grid cards oae-features" markdown>

- :material-brain: **[LLM Providers](providers/llm/index.md)**
OpenAI, Anthropic, Gemini, Groq, OpenRouter, Ollama — plus a Mock provider for offline tests.

- :material-database-search: **[Retrievers](providers/retrievers/index.md)**
Chroma, Qdrant, Pinecone, Weaviate, FAISS, PGVector, Elasticsearch, BM25, Memory, HTTP, Mock.

- :material-vector-point: **[Embedders](providers/embedders/index.md)**
Sentence-Transformers ships in the box; bring your own via the provider base classes.

</div>

Bring your own by implementing the provider base classes — see [API Reference](api.md).

Expand Down
3 changes: 2 additions & 1 deletion docs/overrides/main.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,8 @@
{% endblock %}

{% block extrahead %}
{# Preconnect to speed up font loading #}
{# Font loading: Inter + JetBrains Mono come from theme.font; add Space Grotesk display #}
<link rel="preconnect" href="https://fonts.googleapis.com">
<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
<link rel="stylesheet" href="https://fonts.googleapis.com/css2?family=Space+Grotesk:wght@500;600;700&display=swap">
{% endblock %}
Loading
Loading