codeant-ai-for-open-source[bot] commented on PR #36761: URL: https://github.com/apache/superset/pull/36761#issuecomment-3674195449
## Nitpicks 🔍 <table> <tr><td>🔒 <strong>No security issues identified</strong></td></tr> <tr><td>⚡ <strong>Recommended areas for review</strong><br><br> - [ ] <a href='https://github.com/apache/superset/pull/36761/files#diff-b3e6185638da54ee29f1d54f4496274f5d92fcfe24d888feabd6e9e3cfec2bbbR19-R22'><strong>MDX/admonition parsing</strong></a><br>The new `:::resources` custom admonition block relies on the Docusaurus MDX parser and the project's custom container registration. Verify the custom container is registered and that this exact placement/format (no title on the same line, list syntax inside) renders correctly in both dev and production builds and in light/dark modes.<br> - [ ] <a href='https://github.com/apache/superset/pull/36761/files#diff-f460a0f83b1402fc10a2ab0653f40aba549a2bbed08a971577db8b1a2b5248fcR84-R84'><strong>Custom Admonition Registration</strong></a><br>This file uses a custom admonition token `:::resources`. If the new admonition component/keyword is not properly registered in the Docusaurus MDX/remark pipeline, the docs build will either render incorrectly or fail. Verify the component name, the registration in Docusaurus config, and that the component is shipped with the site.<br> - [ ] <a href='https://github.com/apache/superset/pull/36761/files#diff-c320155d4d1897c6db7537287db470fd88c9e9b3badaf7e62927a0d4dc9cb12bR102-R105'><strong>Admonition closure</strong></a><br>Several new `:::resources` admonitions were added. If any closing `:::` delimiters are indented or missing, the MDX/markdown may not render the admonition correctly (it can remain open or break the page layout). Verify every added admonition has a matching, non-indented closing `:::` on its own line.<br> - [ ] <a href='https://github.com/apache/superset/pull/36761/files#diff-ebe2a1fa71cda5af30345b8c864766cffa2ee46562d22fe3093176c0b4e4961cR117-R121'><strong>Admonition registration</strong></a><br>The file now contains inline `:::resources` admonitions. Verify that the custom `resources` admonition is actually registered in the Docusaurus config and that the build pipeline recognizes this syntax. If the plugin/MDX remark is not registered, these blocks will render as plain text and not the intended styled component.<br> - [ ] <a href='https://github.com/apache/superset/pull/36761/files#diff-62cd168bee744bbe1b2dd0f5b0941dfa6ca8432a9997c32d64eac06fe4b0d555R139-R142'><strong>Build failure risk</strong></a><br>The new `:::resources` custom admonition relies on a registered MDX/React component and Docusaurus config. If the custom admonition/component or its registration is missing or misconfigured, the docs build will fail. Verify the `ResourcesAdmonition` component exists and that `resources` is registered in the Docusaurus plugin/config.<br> </td></tr> </table> -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
