docs: add agent rollout ingestion docs entry point#499
Conversation
Greptile SummaryThis PR creates a dedicated
|
| Filename | Overview |
|---|---|
| docs/concepts/agent-rollout-ingestion.md | New canonical page for AgentRolloutSeedSource; contains Quick Start tabs, normalized field compatibility table, and two complete code examples. Content is accurate and well-structured. |
| docs/concepts/seed-datasets.md | Rollout-specific inline content replaced with a pointer admonition to the new dedicated guide; "Custom Filesystem Readers" tip relocated to the DirectorySeedSource section where it belongs semantically. |
| docs/concepts/traces.md | Single "See Also" bullet added linking to the new Agent Rollout Ingestion page; correct relative path used. |
| docs/recipes/cards.md | Adds an "Ingestion Guide" button to the rollout distillation recipe card pointing to the new concepts page; relative path is correct. |
| docs/recipes/trace_ingestion/agent_rollout_distillation.md | Adds an info admonition near the top pointing to the new ingestion guide; relative path ../../concepts/agent-rollout-ingestion.md is correct from this depth. |
| mkdocs.yml | New page added to Concepts nav immediately after Seed Datasets; placement and file path are correct. |
Flowchart
%%{init: {'theme': 'neutral'}}%%
flowchart TD
SD[concepts/seed-datasets.md] -->|"!!! info pointer"| ARI[concepts/agent-rollout-ingestion.md]
TR[concepts/traces.md] -->|"See Also link"| ARI
RC[recipes/cards.md] -->|"Ingestion Guide button"| ARI
ARD[recipes/trace_ingestion/agent_rollout_distillation.md] -->|"!!! info pointer"| ARI
NAV[mkdocs.yml Concepts nav] --> ARI
ARI --> QS["Quick Start\n(Claude Code / Codex / Hermes / ATIF)"]
ARI --> NFC["Normalized Field\nCompatibility Table"]
ARI --> EX1["Example: Summarize a Random Turn"]
ARI --> EX2["Example: Tool Interaction Review Dataset"]
ARI --> REL["Related Guides (back-links)"]
Reviews (3): Last reviewed commit: "Merge branch 'main' into codex/agent-rol..." | Re-trigger Greptile
Add a dedicated concepts entry for agent rollout ingestion and link existing rollout-related docs back to it so the detailed guide can be filled in separately. Signed-off-by: Eric W. Tramel <eric.tramel@gmail.com>
53fc050 to
b5e68ea
Compare
SummaryThis docs-only PR creates a dedicated entry point for agent rollout ingestion documentation ( PR: #499 — FindingsAccuracy — API references vs. source codeAll referenced classes and enums exist in the codebase and match their documented behavior:
Default paths match the code:
Links — internal cross-referencesAll internal links resolve correctly:
Link — external reference (low severity)
Navigation placementThe new page sits at Content consolidationThe original Normalized field tableThe compatibility table is well-structured and comprehensive. The Code examples
Minor observations (non-blocking)
VerdictApprove — This is a clean, well-structured docs PR. All API references are accurate against the current codebase, internal links resolve correctly, the nav placement is logical, and the content consolidation from The only item to verify before merge is the external Harbor ATIF documentation link ( |
📋 Summary
This PR creates a dedicated documentation entry point for agent rollout ingestion so rollout-specific guidance can live outside the broader seed-datasets page. It also adds breadcrumbs from the existing rollout-related docs so users can consistently find that guide before the detailed content pass lands.
🔗 Related Issue
N/A
🔄 Changes
docs/concepts/agent-rollout-ingestion.mdas the new canonical page scaffold for rollout ingestion docsmkdocs.yml🧪 Testing
uv run --group docs mkdocs buildmake testpasses (not run; docs-only change)uv run --group docs mkdocs build --strictpasses (blocked by pre-existing repo docs warnings unrelated to this PR)✅ Checklist