Audit pass 3: Memory + Handoff polish, cross-references, glossary entries#101
Merged
Merged
Conversation
…ries Final audit pass over hyc/orchestration-launch ahead of the rollout PR. Covers the deltas from #86 (Agent Memory research preview) and #85 (local\u2194cloud handoff) that landed after audit pass 2. Sentence case / Title Case: - capabilities/skills.mdx:414: '## Suggested Skills from Agent Memory' -> '## Suggested skills from Agent Memory'. The section body uses lowercase 'skill drafts', so the heading should match. Also clears the one new style_lint warning introduced by #86. Stale config: - agent-platform/agent-memory/index.mdx: drop '(Research Preview)' from the frontmatter sidebar.label. sidebar.ts already overrides the label to 'Agent Memory' under a group named 'Memory (Research Preview)'; the duplicate annotation was dead config. Cross-link gaps from neighboring pages: - cloud-agents/viewing-cloud-agent-runs.mdx (the '5. Fork the session to your local Warp' section): add a one-line reference to the new Handoff overview, so the cloud-to-local direction is discoverable from the broader handoff doc. - cloud-agents/managing-cloud-agents.mdx: add a Related pages section that links to the Handoff overview and the other neighbors that weren't surfaced before. - local-agents/cloud-conversations.mdx (Related features): add a link to the Handoff overview, since handoff relies on cloud-synced conversations. Style: - cloud-agents/handoff/index.mdx:30: drop 'just' from 'not just read about it' -> 'not only read about it'. Same ableist-language pattern audit pass 2 cleaned up elsewhere. Glossary additions: - .agents/references/terminology.md (Agent concepts) + AGENTS.md (Core features): add canonical entries for 'Agent Memory', 'memory store', and 'Handoff' so the launch terms ship with documented capitalization rules ('Agent Memory' Title Case as a feature; 'memory store' lowercase common noun; 'Handoff' Title Case as the feature, lowercase 'hand off' / 'handed off' as the verb). Validation: - check_links --internal-only: 0 broken across 2,543 internal links (up 6 from the 2,537 baseline, matching the 6 new cross-refs). - style_lint --changed: 14 warnings (one fewer than baseline; the skills.mdx Title Case heading is no longer flagged). The remaining warnings are all pre-existing proper-name false positives. - npm run build: 330 pages built; sidebar still resolves all slugs; new anchor reference (#5-fork-the-session-to-your-local-warp) resolves. Co-Authored-By: Oz <oz-agent@warp.dev>
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Contributor
|
I'm starting a first review of this pull request. You can view the conversation on Warp. I completed the review and no human review was requested for this pull request. Comment Powered by Oz |
![oz-for-oss[bot]](https://avatars.githubusercontent.com/in/3450139?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Overview
This PR makes a focused documentation polish pass for Agent Memory and Handoff: terminology entries, sidebar/frontmatter cleanup, a heading style fix, and cross-links from neighboring agent-platform pages. I reviewed the annotated diff against the provided PR description and spec context; the change is documentation-only, the new internal references are consistent with the PR diff, and there are no material spec or security concerns.
Concerns
- None.
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
Revert the sidebar.label change from the audit pass. Keeping the research-preview annotation in the frontmatter as a defensive fallback in case the sidebar.ts override is ever removed. Co-Authored-By: Oz <oz-agent@warp.dev>
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.
Final audit pass over
hyc/orchestration-launchbefore the rollout PR. Covers the deltas from #86 (Agent Memory research preview) and #85 (local\u2194cloud handoff) that landed after audit pass 2. 8 files changed, +24 / \u22123.Changes
Sentence-case fix (clears the one new style-lint warning):
capabilities/skills.mdx:414\u2014## Suggested Skills from Agent Memory\u2192## Suggested skills from Agent Memory. The section body refers to "reviewable skill drafts" (lowercase common noun), so the heading now matches.Dead frontmatter:
agent-platform/agent-memory/index.mdx\u2014 drop the(Research Preview)suffix from the frontmattersidebar.label.sidebar.tsalready overrides it toAgent Memoryunder a group namedMemory (Research Preview); the duplicate annotation was dead config.Cross-link gaps from neighboring pages \u2014 new pages linked out, but the existing pages didn't link back:
cloud-agents/viewing-cloud-agent-runs.mdx(the \u201C5. Fork the session to your local Warp\u201D section): add a one-line reference to the Handoff overview so the cloud-to-local direction is discoverable from the broader doc.cloud-agents/managing-cloud-agents.mdx: add a \u201CRelated pages\u201D section linking to the Handoff overview alongside cloud-agents overview, viewing-cloud-agent-runs, and oz-web-app.local-agents/cloud-conversations.mdx(Related features): add a link to the Handoff overview, since handoff relies on cloud-synced conversations.Style (consistency with audit pass 2):
cloud-agents/handoff/index.mdx:30\u2014 \u201Cthe receiving agent can resume the work, not just read about it\u201D \u2192 \u201C\u2026not only read about it.\u201DGlossary additions:
.agents/references/terminology.md(Agent concepts) andAGENTS.md(Core features) \u2014 canonical entries for the launch terms:Validation
check_links --internal-only: 0 broken across 2,543 internal links (up 6 from the 2,537 baseline, matching the 6 new cross-refs).style_lint --changed: 14 warnings (one fewer than baseline) \u2014 the newSuggested Skills\u2026heading is no longer flagged. The remaining 14 are all pre-existing proper-name false positives in pricing-faqs / add-on-credits / BYOK / Slack-Linear integration headers.npm run build: 330 pages built; sidebar resolves all slugs; the#5-fork-the-session-to-your-local-warpanchor reference resolves.Out of scope
&hotkey inhandoff/local-to-cloud.mdx:39is potentially ambiguous (literal&vsShift+7); needs product verification.Co-Authored-By: Oz oz-agent@warp.dev