Makes changes needed to update LLM generation and use resolve_md plugin#298
Makes changes needed to update LLM generation and use resolve_md plugin#298dawnkelly09 wants to merge 9 commits intomasterfrom
Conversation
There was a problem hiding this comment.
Pull request overview
This pull request enhances Moonbeam's documentation site with improved AI/LLM integration capabilities, including a new plugin configuration, updated copy/download functionality for AI resources, and refined styling. The changes introduce a structured approach to generating and serving AI-consumable documentation content.
Changes:
- Added
resolve_mdplugin configuration withllms_config.jsonto manage AI resource generation - Replaced clipboard copy script with improved copy/download functionality supporting both copy-to-clipboard and file download actions
- Added new CSS styling for copy-to-LLM UI components with responsive design
- Updated robots.txt to prevent crawling of AI artifacts directory
Reviewed changes
Copilot reviewed 7 out of 7 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| robots.txt | Added disallow rule for /ai/ directory to prevent search engine indexing |
| mkdocs.yml | Updated plugin configuration to add resolve_md plugin, replaced old clipboard script with new copy-to-llms.js, added copy-to-llm.css |
| material-overrides/partials/footer.html | Updated llms-full link to point to new JSONL format at /ai/ path |
| material-overrides/main.html | Completely refactored JavaScript for copy/download functionality with proper URL resolution, blob-based downloads, and improved error handling |
| material-overrides/assets/stylesheets/moonbeam.css | Added .actions class for flex layout in code navigation |
| material-overrides/assets/stylesheets/copy-to-llm.css | New file with comprehensive styling for copy-to-LLM UI components including split buttons, dropdowns, and mobile responsiveness |
| llms_config.json | New configuration file defining project metadata, repository settings, content structure, and output paths for LLM resource generation |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 8 out of 8 changed files in this pull request and generated 6 comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
themacexpert
left a comment
themacexpert
left a comment
There was a problem hiding this comment.
Added relevant comments on moonbeam-foundation/moonbeam-docs#1374
|
Draft mode pending Rose deployment. Currently, the per-page widget renders on the Chinese site pages but, we don't have support for generating the needed files in Chinese in order to serve them to users. |
eshaben
left a comment
eshaben
left a comment
There was a problem hiding this comment.
I think we should use green instead of purple for the dropdowns, so it more closely aligns with the header buttons and links.
|
|
||
| a.addEventListener('click', (e) => { | ||
| const url = toAbsolute(a.getAttribute('data-path') || ''); | ||
| if (!url) return; | ||
| if (a.getAttribute('target') !== '_blank') { | ||
| e.preventDefault(); | ||
| window.open(url, '_blank', 'noopener'); | ||
| } | ||
| }); |
There was a problem hiding this comment.
you know what I'm going to say about this 🙂
3 participants
Goes with moonbeam-docs PR: moonbeam-foundation/moonbeam-docs#1374
This pull request introduces several improvements to Moonbeam's documentation site, focusing on enhanced AI/LLM integration, user interface updates for copy/download actions, and configuration for AI-related resources. The most significant changes include the addition of a new LLM configuration file, improvements to the copy/download user experience, and updates to styles and plugin configuration.
AI/LLM Integration and Configuration:
llms_config.jsonfile to define project, repository, content, and output settings for LLM-related documentation processing.mkdocs.ymlconfiguration to include the newresolve_mdplugin with a reference tollms_config.json.Copy/Download UI and Functionality:
copy-to-llms.js, updated related CSS (copy-to-llm.css), and improved the logic inmain.htmlto handle copy/download actions more robustly, including proper URL resolution, download via Blob, and user feedback. [1] [2] [3]llms-full.jsonl) hosted under/ai/, aligning with the new configuration and resource structure.Styling and UX Enhancements:
.actionsclass for flex layout in code navigation.Robots and SEO:
robots.txtto disallow crawling of the/ai/directory, preventing search engines from indexing AI artifacts.Plugin and Asset Management:
mkdocs.ymlto use the new scripts and styles, ensuring consistency across the site. [1] [2]These changes collectively improve the site's AI/LLM resource integration, make copy/download actions more user-friendly and robust, and ensure proper configuration and SEO handling for new AI-related content.