fix: Fix the failing format of md files.#1400
Conversation
Clean up and format MCP guides, resolve merge conflicts, and update the Vite configuration tip to use standard Markdown alert blocks.
sugoi-yuzuru
requested review from
josemontespg and
zeroasterisk
and removed request for
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 updates the A2UI documentation by reorganizing the MCP integration guides, simplifying sample setup steps, and converting MkDocs admonitions to GitHub alert syntax. Review feedback recommends using backticks for URLs and file names to ensure consistency and warns that the syntax change for tips might break rendering if the documentation is built with MkDocs.
| #### Step 3: Open in Browser | ||
|
|
||
| Open your browser and navigate to `http://localhost:5173`. You should see the A2UI interface loading the MCP App. | ||
| Open your browser and navigate to `http://localhost:5173/`. You should see the A2UI interface loading the MCP App. |
There was a problem hiding this comment.
The URL should be wrapped in backticks for better readability and consistency with the rest of the guide. This also applies to the URL on line 154.
| }) | ||
| ``` | ||
| This will ensure that all JS and CSS assets are inlined into the `index.html` file on build, making it ready to be served by your MCP server as a single resource. | ||
| > [!TIP] |
There was a problem hiding this comment.
The change from !!! tip to > [!TIP] replaces MkDocs admonition syntax with GitHub-specific alert syntax. If the project's documentation site is built using MkDocs, this will break the visual rendering of the tip box. Ensure this change is intentional and compatible with the documentation toolchain.
There was a problem hiding this comment.
This seems to work? https://a2ui.org/guides/a2ui-in-mcp-apps/#step-1-inlining-the-renderer
| > }); | ||
| > ``` | ||
| > | ||
| > This will ensure that all JS and CSS assets are inlined into the `index.html` file on build, making it ready to be served by your MCP server as a single resource. |
There was a problem hiding this comment.
This paragraph should be aligned as a separate paragraph within the tip block rather than being indented as part of the second list item. Additionally, index.html (here) and vite-plugin-singlefile (on line 110) should be wrapped in backticks to match the project's documentation style.
| > This will ensure that all JS and CSS assets are inlined into the `index.html` file on build, making it ready to be served by your MCP server as a single resource. | |
| > This will ensure that all JS and CSS assets are inlined into the index.html file on build, making it ready to be served by your MCP server as a single resource. |
3 participants
Description
NOOP: Fix the failing format
Pre-launch Checklist
If you need help, consider asking for advice on the discussion board.