Skip to content

docs(control): add the audit trail page - #28

Open
bexchauveto wants to merge 4 commits into
mainfrom
audit-trail
Open

docs(control): add the audit trail page#28
bexchauveto wants to merge 4 commits into
mainfrom
audit-trail

Conversation

@bexchauveto

@bexchauveto bexchauveto commented Aug 18, 2026

Copy link
Copy Markdown
Member

Summary

  • Adds a new page documenting the agent-native audit trail (get-started/control/audit-trail.mdx): enabling it (Node.js and Ruby), options (including critical), what's stored, the pending/confirm write protocol, smart-action capture, the History tab, HTTP routes, search semantics, reconstructing a past state, and known limitations.
  • Adds the page to the nav in docs.json, under Control alongside Scopes & Visibility and Audit & Activity Logs.
  • Cross-links it from get-started/control/audit.mdx (the existing activity-log page).
  • Adds the auditTrail/audit_trail option to the agent option reference tables in reference/agent-api/nodejs.mdx and reference/agent-api/ruby.mdx.

Node.js and Ruby agents are documented at feature parity throughout (identity columns, critical, search, scope-withholding, migration table naming).

Test plan

  • Fence/code-block balance checked (grep -c '```' is even).
  • Manually review the rendered page in Mintlify preview for both the Node.js and Ruby tabs.
  • Click through the cross-links (audit.mdxaudit-trail.mdx, and the #write-protocol/#searching anchors) to confirm they resolve.

Note

Add audit trail documentation to the Control getting started guide

  • Adds a new audit-trail.mdx page covering purpose, configuration (Node.js and Ruby), field redaction, storage schema, write protocol, smart action behavior, the History tab UI, and HTTP query routes.
  • Updates audit.mdx with an info callout linking to the new page.
  • Documents the auditTrail / audit_trail option in the Node.js and Ruby agent API references with links back to the guide.

Macroscope summarized c470fa3.

Documents the agent-native audit trail (write protocol, critical
option, stored columns, smart-action capture, HTTP routes, search
semantics, and limitations) for both Node.js and Ruby, cross-linked
from the existing activity-log page and the agent option references.
@mintlify

mintlify Bot commented Aug 18, 2026

Copy link
Copy Markdown

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
forest 🟢 Ready View Preview Aug 18, 2026, 3:53 PM

💡 Tip: Enable Workflows to automatically generate PRs for you.

…s_record_id

Mirrors the caveat already documented in agent-ruby's AUDIT_TRAIL.md so
the divergence is discoverable regardless of which agent's docs a
reader lands on first.
Comment thread get-started/control/audit-trail.mdx Outdated
Co-authored-by: macroscopeapp[bot] <170038800+macroscopeapp[bot]@users.noreply.github.com>
Node's agent now caps a smart action's audited selection at the same
1000 as a bulk update/delete, matching the Ruby agent's identical fix.
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.

1 participant