okf: add optional agent-routing hint fields (SPEC 4.1)#189
Open
manumishra12 wants to merge 1 commit into
Open
Conversation
Adds an optional, additive frontmatter convention (purpose / task / audience) so consumption agents can decide whether and how to use a concept before reading its body. The fields are hints, never gates: consumers must tolerate their absence. Backward-compatible additive convention (per SPEC 11). Addresses GoogleCloudPlatform#96.
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
1 participant
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.
What
Adds an optional, additive frontmatter convention to SPEC section 4.1 for agent-routing hints —
purpose,task, andaudience— so a consumption agent can decide whether and how to use a concept before reading its body.Semantics
purpose— one line on what the concept is for.task— the task(s) the concept is most useful for (string or list).audience— the intended reader/agent (string or list).These are hints, never gates: consumers MUST tolerate their absence and MUST NOT reject a document that omits them. Section 4.1 already permits arbitrary producer keys; this names three with a shared meaning so producers and consumers can rely on them.
Backward-compatible additive convention (SPEC section 11 minor-version rules).
Addresses #96.