docs(events): clarify event record emission constraints - #230
Draft
cursor[bot] wants to merge 1 commit into
Draft
cursor[bot] wants to merge 1 commit into
cursor[bot] wants to merge 1 commit into
Conversation
Co-authored-by: Sara Loera <saraeloop@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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
Motivation & Context
The event reference described the general
events.jsonlrecord but omitted required top-level fields and did not call out runtime writer behavior that affects integrations emitting or validating event records.Technical Details
docs/reference/events.mdxwith requiredtimestamp,episode_id, andevidence_idsguidance.write_event(), timestamp normalization, metrics requirements, faculty tagging, and runtime lifecycle events.actpayload field descriptions.Validation
Required
python3smoke validation forwrite_event()required fields, timestamp alignment, faculty injection, and runtimeevent_typevalidation.Situational
pnpm run buildin 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
Related Issues / References
noesis.trace.events.write_event()andnoesis/trace/schemas/events/1.3.0.json.