Fix nested list indentation in docs#1368
Conversation
|
Thanks for your pull request! It looks like this may be your first contribution to a Google open source project. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA). View this failed invocation of the CLA check for more information. For the most up to date status, view the checks section at the bottom of the pull request. |
There was a problem hiding this comment.
Code Review
This pull request standardizes indentation and formatting across several documentation files, including catalogs, ecosystem guides, and renderer development references. The review feedback suggests improving consistency in the 'Defining Your Own Catalog' guide by adding a missing step to the Flutter section to match the Web section and standardizing the markdown syntax used for italicized notes.
Description
Fix nested Markdown list indentation so Python-Markdown/MkDocs renders intended child lists instead of flattening them into the parent list.
This updates the affected docs sections to use 4-space indentation for nested list items, including the Web tab block in
defining-your-own-catalog.mdso list items stay inside the tab content.Affected areas:
docs/concepts/catalogs.md: Versioning Guidelines and Graceful Degradation examplesdocs/guides/renderer-development.md: Message Processing, Rendering Logic, and Client-to-Server Communication listsdocs/guides/mcp-apps-in-a2ui.md: MCP App Standalone Sample subitemsdocs/ecosystem/a2ui-in-the-world.md: Open Source Examples descriptionsdocs/reference/agents.md: Sample Agents descriptionsdocs/guides/defining-your-own-catalog.md: Web tab list structureScreenshots
Catalogs: Versioning Guidelines
Before, current live site:
After, local MkDocs build:
Defining Your Own Catalog: Web tab
Before, current live site:
After, local MkDocs build:
Verification
git diff --checkmkdocs build -f mkdocs.yamlmkdocs serveChrome DOM checks:
https://a2ui.org/concepts/catalogs/#versioning-guidelinescurrently hasBreaking Changesnested items = 0 and flat child items = 2./concepts/catalogs/has nested items underBreaking Changes,Non-Breaking Changes, and both Graceful Degradation examples./guides/defining-your-own-catalog/has the Web tab content inside the tab block, with 2 top-level list items and 1 nested item./guides/renderer-development/,/guides/mcp-apps-in-a2ui/,/ecosystem/a2ui-in-the-world/, and/reference/agents/.Note:
mkdocs build --strict -f mkdocs.yamlstill reports existing unrelated warnings forglossary.mdnav inclusion,guides/authoring-components.mdmacro rendering, and two existing links inspecification/v0.9-a2ui.md.Pre-launch Checklist
If you need help, consider asking for advice on the discussion board.