Add import instructions section to model catalog pages with link
Description
This PR fixes #2388
This enhancement adds import instructions and a link to the documentation on all model pages in the catalog. Users viewing individual model pages will now see a "How to Import This Model" section that guides them to the [importing models documentation](https://docs.meshery.io/guides/configuration-management/importing-models).
Changes made:
- Added a new import instructions section to the model page template
- Included direct link to https://docs.meshery.io/guides/configuration-management/importing-models with proper target and rel attributes
- Implemented custom CSS styling (
.import-instructionsclass) with Meshery brand color (#00b39f) for visual consistency - Positioned section between model metadata and action buttons for logical user flow
- Cleaned up CSS formatting and removed unnecessary commented code
- Maintained all existing functionality and Jekyll liquid template logic
Screenshots:
Before:
After:
Notes for Reviewers
The import instructions section has been strategically placed between the model metadata and the download/quick start buttons to create an intuitive user experience:
- Users first see the model details (metadata)
- Then learn how to import it (new section)
- Finally can take action (download/quick start buttons)
The styling uses Meshery's existing brand color (#00b39f) for the left border accent and follows established design patterns from the rest of the site. The section features:
- Light gray background (#f8f9fa) for subtle visual separation
- Responsive design that works well on mobile devices
- Hover effects on the documentation link for better interactivity
- Proper spacing and padding that aligns with existing UI elements
The implementation is non-intrusive and enhances user guidance without disrupting the existing layout or breaking any current functionality.
[Signed commits](https://docs.meshery.io/project/contributing#signing-off-on-commits-developer-certificate-of-origin)
- [x] Yes, I signed my commits.
Deploy Preview for mesheryio-preview ready!
| Name | Link |
|---|---|
| Latest commit | e9941cba4559419c79ff2e3dc8ffd18a1d9f98ff |
| Latest deploy log | https://app.netlify.com/projects/mesheryio-preview/deploys/691b5792ffe0060008e184ee |
| Deploy Preview | https://deploy-preview-2394--mesheryio-preview.netlify.app |
| Preview on mobile | Toggle QR Code...Use your smartphone camera to open QR code link. |
To edit notification comments on pull requests, go to your Netlify project configuration.
Summary of Changes
Hello @phoenixcodeforces-blip, I'm Gemini Code Assist[^1]! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!
This pull request introduces a significant enhancement to the model catalog pages by adding a new 'How to Import This Model' section. This addition aims to improve user experience by providing clear guidance and a direct link to the relevant documentation for importing models, making it easier for users to utilize the models within their Meshery instances.
Highlights
- New Import Instructions Section: A dedicated 'How to Import This Model' section has been added to all individual model catalog pages to guide users.
- Documentation Link Integration: The new section includes a direct link to the Meshery documentation on importing models, ensuring users have immediate access to detailed instructions.
- Custom Styling for Consistency: Custom CSS styling (
.import-instructions) has been implemented, utilizing Meshery's brand color (#00b39f) and established design patterns for visual consistency. - Strategic Placement: The new section is strategically positioned between the model metadata and action buttons to create a logical and intuitive user flow.
- Code Cleanup and Maintenance: CSS formatting has been cleaned up, unnecessary commented code removed, and existing functionality and Jekyll liquid template logic have been maintained.
Using Gemini Code Assist
The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.
Invoking Gemini
You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.
| Feature | Command | Description |
|---|---|---|
| Code Review | /gemini review |
Performs a code review for the current pull request in its current state. |
| Pull Request Summary | /gemini summary |
Provides a summary of the current pull request in its current state. |
| Comment | @gemini-code-assist | Responds in comments when explicitly tagged, both in pull request comments and review comments. |
| Help | /gemini help |
Displays a list of available commands. |
Customization
To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.
Limitations & Feedback
Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with :thumbsup: and :thumbsdown: on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.
You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.
[^1]: Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.
Hi @fitzergerald, I have completed the implementation, resolved bot review, and passed the workflow, this PR is ready for review, Thank you.
Thank you for your contribution! Let's discuss this during the website call today at 5:30 PM IST | 7 AM CT Add it as an agenda item to the meeting minutes, if you would π
Hi @Rajesh-Nagarajan-11 I missed the comment(I got late), Can we discuss it in the next meeting?
Sure
Hi @Namanv0509 @Rajesh-Nagarajan-11 Can you please review this PR?
thank you.
Thank you for your contribution! Letβs discuss this during the website call tomorrow (November 3) at 5:30 PM IST | 7:00 AM CT. Please add it as an agenda item to the meeting minutes π
https://docs.meshery.io/guides/configuration-management/importing-models
Please make it dark / light mode compatible , in dark mode that card is white
@Rajesh-Nagarajan-11
I have fixed the css for that section,