Skip to content

docs(events): clarify event record emission constraints - #230

Draft
cursor[bot] wants to merge 1 commit into
mainfrom
cursor/technical-documentation-improvements-daaa
Draft

cursor[bot] wants to merge 1 commit into
mainfrom
cursor/technical-documentation-improvements-daaa

Conversation

@cursor

@cursor cursor Bot commented Jun 1, 2026

Copy link
Copy Markdown
Contributor

Noesis Pull Request

Overview

Updates the events schema reference to align the documented base event shape with the runtime writer and JSON schema contract.

Type of Change

  • Documentation or research notes

Motivation & Context

The event reference described the general events.jsonl record but omitted required top-level fields and did not call out runtime writer behavior that affects integrations emitting or validating event records.

Technical Details

  • Updated docs/reference/events.mdx with required timestamp, episode_id, and evidence_ids guidance.
  • Documented source-backed emission constraints for write_event(), timestamp normalization, metrics requirements, faculty tagging, and runtime lifecycle events.
  • Removed duplicate act payload field descriptions.

Validation

Required

  • Equivalent targeted suite: python3 smoke validation for write_event() required fields, timestamp alignment, faculty injection, and runtime event_type validation.
  • Schema validation and export diff clean: documentation-only change, no schema artifacts changed.

Situational

  • Docs build successfully (pnpm run build in docs/) - not run; no docs build script is defined in this repository.

Observability & Safety

Clarifies the public observability trace contract for integrations that emit or consume events.jsonl. No runtime behavior changed.

Educational / Research Value

Makes the event ledger contract easier to scan and troubleshoot for developers writing adapters, validators, and operational runbooks.

Screenshots / Logs

event docs smoke validation passed

Related Issues / References

  • Source-backed against noesis.trace.events.write_event() and noesis/trace/schemas/events/1.3.0.json.
Open in Web View Automation 

Co-authored-by: Sara Loera <saraeloop@users.noreply.github.com>
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