update docs: verified hyperlinks, used doc writing skill#1088
update docs: verified hyperlinks, used doc writing skill#1088wrenj merged 1 commit intogoogle:mainfrom
Conversation
wrenj
requested review from
gspencergoog,
jacobsimionato,
nan-yu,
polina-c and
zeroasterisk
and removed request for
nan-yu and
zeroasterisk
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request standardizes the project's documentation by fixing relative paths, improving phrasing, and ensuring consistent punctuation in lists. It also converts MkDocs admonitions into a blockquote-based format to support the build pipeline. Review feedback identifies several instances where the required blockquote prefix was missing or where alert headers were redundant, such as 'NOTE: Note'.
| 4. Run the tool → the response contains A2UI JSON that renders a recipe card | ||
|
|
||
| > ⚠️ **Note** | ||
| > NOTE: Note |
There was a problem hiding this comment.
The alert header is redundant. "NOTE: Note" repeats the label. It should be simplified to just "NOTE".
| > NOTE: Note | |
| > NOTE |
| ``` | ||
|
|
||
| > ⚠️ **Tip** | ||
| > TIP: Tip |
There was a problem hiding this comment.
The alert header is redundant. "TIP: Tip" repeats the label. It should be simplified to just "TIP".
| > TIP: Tip | |
| > TIP |
| WARNING: Security Notice | ||
|
|
||
| This demo runs an A2A agent that uses Gemini to generate A2UI responses. The agent has access to your API key and will make requests to Google's Gemini API. Always review agent code before running it in production environments. |
There was a problem hiding this comment.
This alert is missing the blockquote prefix (> ). According to docs/scripts/README.md, the documentation build pipeline expects a blockquote-based syntax to correctly transform alerts into MkDocs admonitions.
| WARNING: Security Notice | |
| This demo runs an A2A agent that uses Gemini to generate A2UI responses. The agent has access to your API key and will make requests to Google's Gemini API. Always review agent code before running it in production environments. | |
| > WARNING: Security Notice | |
| > | |
| > This demo runs an A2A agent that uses Gemini to generate A2UI responses. The agent has access to your API key and will make requests to Google's Gemini API. Always review agent code before running it in production environments. |
| NOTE: Demo Running | ||
|
|
||
| If everything worked, you should see the web app in your browser. The agent is now ready to generate UI! |
There was a problem hiding this comment.
This alert is missing the blockquote prefix (> ). The build pipeline requires blockquotes for proper admonition rendering.
| NOTE: Demo Running | |
| If everything worked, you should see the web app in your browser. The agent is now ready to generate UI! | |
| > NOTE: Demo Running | |
| > | |
| > If everything worked, you should see the web app in your browser. The agent is now ready to generate UI! |
| TIP: It's Just JSON | ||
|
|
||
| Notice how readable and structured this is? LLMs can generate this easily, and it's safe to transmit and render—no code execution required. |
There was a problem hiding this comment.
This alert is missing the blockquote prefix (> ). The build pipeline requires blockquotes for proper admonition rendering.
| TIP: It's Just JSON | |
| Notice how readable and structured this is? LLMs can generate this easily, and it's safe to transmit and render—no code execution required. | |
| > TIP: It's Just JSON | |
| > | |
| > Notice how readable and structured this is? LLMs can generate this easily, and it's safe to transmit and render—no code execution required. |
| IMPORTANT: Attention | ||
| This area is under active design. The developer ergonomics are not yet finalized. |
There was a problem hiding this comment.
This alert is missing the blockquote prefix (> ). The build pipeline requires blockquotes for proper admonition rendering.
| IMPORTANT: Attention | |
| This area is under active design. The developer ergonomics are not yet finalized. | |
| > IMPORTANT: Attention | |
| > | |
| > This area is under active design. The developer ergonomics are not yet finalized. |
2 participants
No description provided.