Add AEO citation blocks (40-60 word summaries) to key pages#63
Open
rachaelrenk wants to merge 1 commit into
Open
Add AEO citation blocks (40-60 word summaries) to key pages#63rachaelrenk wants to merge 1 commit into
rachaelrenk wants to merge 1 commit into
Conversation
Add answer-first introductory paragraphs to Tier 1 docs pages to improve AI answer engine citability. Each citation block is a concise 40-60 word summary placed at the top of the page that directly answers 'What is this feature?' in a self-contained, extractable format. Pages updated: - Site root (index.mdx), quickstart, agents overview - Local agents, cloud agents, CLI agents overviews - Capabilities, MCP, Warp Drive, Blocks, Code, Editor overviews - Oz CLI and API/SDK references, Enterprise overview Co-Authored-By: Oz <oz-agent@warp.dev>
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
|
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}
There was a problem hiding this comment.
Overview
This PR adds answer-first citation blocks to Tier 1 docs pages. The changes are documentation-only and generally align with AEO guidance; I found one terminology/style issue in the updated landing page copy.
Concerns
- The landing page now hyphenates
open-source, but the docs terminology guide prefersopen sourcein prose.
Verdict
Found: 0 critical, 0 important, 1 suggestions
Approve with nits
Comment /oz-review on this pull request to retrigger a review (up to 3 times on the same pull request).
Powered by Oz
| import VideoEmbed from '@components/VideoEmbed.astro'; | ||
|
|
||
| Warp is an [open source](https://github.com/warpdotdev/warp) **Agentic Development Environment**, a modern terminal combined with powerful agents that help you build, test, deploy, and debug code. Warp's AI is powered by **Oz**, the orchestration platform for cloud agents. | ||
| Warp is an [open-source](https://github.com/warpdotdev/warp) **Agentic Development Environment** that combines a modern, high-performance terminal with powerful agents to help you build, test, deploy, and debug code. Warp's agents are powered by **Oz**, the orchestration platform for running agents locally or in the cloud at scale. |
There was a problem hiding this comment.
💡 [SUGGESTION] Use the glossary-preferred open source spelling in prose.
Suggested change
| Warp is an [open-source](https://github.com/warpdotdev/warp) **Agentic Development Environment** that combines a modern, high-performance terminal with powerful agents to help you build, test, deploy, and debug code. Warp's agents are powered by **Oz**, the orchestration platform for running agents locally or in the cloud at scale. | |
| Warp is an [open source](https://github.com/warpdotdev/warp) **Agentic Development Environment** that combines a modern, high-performance terminal with powerful agents to help you build, test, deploy, and debug code. Warp's agents are powered by **Oz**, the orchestration platform for running agents locally or in the cloud at scale. |
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.
Summary
Adds answer-first introductory paragraphs (40-60 word citation blocks) to 15 Tier 1 docs pages to improve AI answer engine citability (AEO). Each citation block is a concise, self-contained summary placed at the top of the page that directly answers "What is this feature?" — optimized for extraction by ChatGPT, Perplexity, Google AI Overviews, and similar AI systems.
What changed
12 files edited across the docs site:
index.mdx) — tightened intro, removed redundant "AI" from "AI agents"agent-platform/index.mdx) — clearer local vs. cloud distinction:::notecallout3 pages were already good and left unchanged: CLI agents overview, MCP, Enterprise.
Writing guidelines followed
Each citation block:
Plan
Add AEO Citation Blocks to Key Docs Pages
Conversation
Co-Authored-By: Oz oz-agent@warp.dev