Skip to content

docs: align agent UID wording + terminology + style guide#168

Open
rachaelrenk wants to merge 2 commits into
oz-agent-api-keys-doc-updatefrom
rachael/agent-identities-to-agents-followup
Open

docs: align agent UID wording + terminology + style guide#168
rachaelrenk wants to merge 2 commits into
oz-agent-api-keys-doc-updatefrom
rachael/agent-identities-to-agents-followup

Conversation

@rachaelrenk
Copy link
Copy Markdown
Contributor

@rachaelrenk rachaelrenk commented Jun 1, 2026

Summary

  • Updates the agent_identity_uid OpenAPI description to use cloud agent terminology while preserving the legacy field name.
  • Clarifies that the field name is legacy and only valid for team-owned runs.
  • Adds agent identity / agent identities to the docs style_lint avoided-terminology check while allowing legacy API identifiers in code spans and code blocks.
  • Documents the avoided term in AGENTS.md, .agents/references/terminology.md, and the style_lint skill docs.

Validation

  • git diff --check passed.
  • python3 -m py_compile .agents/skills/style_lint/style_lint.py passed.
  • Targeted style-lint rule test passed: prose agent identity / agent identities is flagged; inline-code agent_identity_uid and /agent/identities are ignored.
  • python3 .agents/skills/style_lint/style_lint.py --changed ran successfully. It reports 8 existing warnings on PR docs: cover Personal / Team / Agent API key types #143’s changed docs files: 7 header-case warnings and 1 ui-backtick warning; no agent identity findings.
  • npm run typecheck passed earlier with 0 errors.
  • npm run build passed earlier; 333 pages built.
  • npm run lint attempted but could not run because trunk is not installed in this shell (sh: trunk: command not found).
  • Terminology scan passed; the only remaining compatibility match is the agent_identity_uid field name.

Conversation: https://staging.warp.dev/conversation/f40611ff-88ce-479a-89da-430038d6a148

Co-Authored-By: Oz oz-agent@warp.dev

Co-Authored-By: Oz <oz-agent@warp.dev>
@cla-bot cla-bot Bot added the cla-signed label Jun 1, 2026
@vercel
Copy link
Copy Markdown

vercel Bot commented Jun 1, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
docs Ready Ready Preview, Comment Jun 1, 2026 5:13pm

Request Review

@oz-for-oss
Copy link
Copy Markdown
Contributor

oz-for-oss Bot commented Jun 1, 2026

@rachaelrenk

I'm starting a first review of this pull request.

I completed the review and no human review was requested for this pull request.

Comment /oz-review on this pull request to retrigger a review (up to 3 times on the same pull request).

Powered by Oz

Copy link
Copy Markdown
Contributor

@oz-for-oss oz-for-oss Bot left a comment

Choose a reason for hiding this comment

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

Overview

This PR updates the agent_identity_uid OpenAPI description to use cloud agent terminology while noting that the field name is legacy and applies only to team-owned runs.

Concerns

  • No blocking concerns found.

Verdict

Found: 0 critical, 0 important, 0 suggestions

Approve

Comment /oz-review on this pull request to retrigger a review (up to 3 times on the same pull request).

Powered by Oz

Co-Authored-By: Oz <oz-agent@warp.dev>
@rachaelrenk rachaelrenk changed the title docs: align agent UID OpenAPI wording docs: align agent UID wording + terminology + style guide Jun 1, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants