Skip to content

docs(agenteye): audit findings link to the exact events they matched - #655

Merged
NiveditJain merged 2 commits into
mainfrom
docs/agenteye-audit-event-links
Aug 10, 2026
Merged

docs(agenteye): audit findings link to the exact events they matched#655
NiveditJain merged 2 commits into
mainfrom
docs/agenteye-audit-event-links

Conversation

@NiveditJain

@NiveditJain NiveditJain commented Aug 6, 2026

Copy link
Copy Markdown
Member

Public half of FailproofAI/agenteye#542, which shipped the enterprise docs only. Opened because two reader-facing behaviours were left undocumented for anyone still evaluating the product.

What changed

audits.mdx — credential-leak findings now link the individual events they matched, so confirming a finding is a click instead of a scroll through a transcript. Two things stated deliberately:

  • the link names the event and never copies the detected secret into the finding — worth saying plainly when the whole subject is a leaked credential, since a reader will otherwise wonder whether reading a finding is a second place their key is written down;
  • an event lost to retention is reported as such, rather than the page selecting nothing and leaving you to guess whether you clicked the wrong thing.

sessions.mdx — individual events are addressable and shareable, and a link into a very long run resolves even when it points past the window the timeline loads.

Audience

Value and contract only, per the public/enterprise split. The bounded load window, the exact-id lookup that reaches past it, and the API fields behind all of it stay in the enterprise docs.

Checks

  • English only — no locale files touched (translate-docs.yml regenerates those).
  • No new pages, so no docs.json nav change is needed.
  • Links are absolute and extensionless (/agenteye/audits).
  • bun run validate:mdx — 720 pages parsed cleanly, no broken images.

🤖 Generated with Claude Code

https://claude.ai/code/session_018eAwrQjqPQpyxYDcBskojA

Summary by CodeRabbit

  • Documentation
    • Documented direct links from credential-leak findings to the relevant session moment.
    • Clarified that detected secrets are not copied into findings.
    • Added details on deep links that automatically select and scroll to session events.
    • Explained messaging for events outside the loaded timeline or no longer available due to retention.

Hermes review

Field Value
Status Reviewing
Head 1e94f27a6831
Updated 2026-08-10T09:54:02.858965892+00:00

Codex is reviewing the current revision in an isolated nested-container harness.

Covers the public half of FailproofAI/agenteye#542, which shipped the
enterprise docs only. Two reader-facing behaviours were undocumented for
anyone still evaluating:

- Audits: credential-leak findings now link the individual events they
  matched, so confirming a finding is a click rather than a scroll. States the
  privacy property that matters when the subject is a leaked secret — the link
  names the event, it never copies the detected value into the finding — and
  that an event lost to retention is reported rather than silently selecting
  nothing.
- Sessions: individual events are addressable, and a link into a very long run
  resolves even when it points past the window the timeline loads.

Value and contract only. The bounded window, the id lookup that resolves past
it, and the API fields behind all of this stay in the enterprise docs.
@coderabbitai

coderabbitai Bot commented Aug 6, 2026

Copy link
Copy Markdown

Review Change Stack

📝 Walkthrough

Walkthrough

AgentEye documentation now covers links from audit findings and errors to individual session events. It describes automatic event selection, bounded timeline loading, secret omission, and messages for events unavailable after retention expiry.

Changes

AgentEye documentation

Layer / File(s) Summary
Event-link and retention guidance
docs/agenteye/audits.mdx, docs/agenteye/sessions.mdx, CHANGELOG.md
The documentation describes direct event links, automatic selection and scrolling, bounded timeline loading, secret omission, and retention-expiry handling.

Estimated code review effort: 1 (Trivial) | ~2 minutes

Possibly related PRs

Suggested labels: enhancement

Suggested reviewers: hermes-exosphere

Poem

A rabbit links each event in line,
To audit clues and moments fine.
Secrets stay tucked, expired ones known,
Clear paths guide each session shown.
Hop, hop—docs now point the way!

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Title check ✅ Passed The title clearly and concisely describes the primary documentation change: linking audit findings to the exact matched events.
Description check ✅ Passed The description thoroughly explains the documentation changes, rationale, scope, audience, and validation performed, despite not using the repository template headings.

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.

@coderabbitai coderabbitai Bot added the enhancement New feature or request label Aug 6, 2026

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@docs/agenteye/sessions.mdx`:
- Line 41: Update the session-link description sentence to use the hyphenated
phrase “two-thirds down” instead of “two thirds down,” without changing the
surrounding wording.
🪄 Autofix

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: a47b6dfd-40f2-4209-ae52-6714ee17a926

📥 Commits

Reviewing files that changed from the base of the PR and between 981f99c and 1e94f27.

📒 Files selected for processing (3)
  • CHANGELOG.md
  • docs/agenteye/audits.mdx
  • docs/agenteye/sessions.mdx

Comment thread docs/agenteye/sessions.mdx
@NiveditJain

Copy link
Copy Markdown
Member Author

@hermes-exosphere review

@hermes-exosphere

Copy link
Copy Markdown
Contributor

Hermes

Status Reviewing
Verdict Not reviewed yet
Head 1e94f27a6831
Rounds 0 of 5

No summary yet.

What this changes

No component map for this revision.

Rounds

No review has finished on this pull request yet.

Findings

Nothing raised yet.


@hermes-exosphere help lists every command. This comment is maintained in place — I rewrite it after each review rather than posting a new one.

@hermes-exosphere

hermes-exosphere commented Aug 10, 2026

Copy link
Copy Markdown
Contributor

Hermes

Status Reviewing
Verdict Not reviewed yet
Head 1e94f27a6831
Rounds 0 of 5

No summary yet.

What this changes

No component map for this revision.

Rounds

Round Reviewed Commits in this round Verdict
0 1e94f27a6831 57b0616a4916 1e94f27a6831 Approved

Findings

Nothing raised yet.


@hermes-exosphere help lists every command. This comment is maintained in place — I rewrite it after each review rather than posting a new one.

@hermes-exosphere hermes-exosphere left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Hermes found no blocking issues in this revision.

@NiveditJain
NiveditJain merged commit f0c24fb into main Aug 10, 2026
11 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants