fix missing screenshots #101
Conversation
Summary of ChangesHello @anthonymarkQA, I'm Gemini Code Assist1! 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 addresses an issue where screenshots were not appearing in the farmer registry installation guide. The problem stemmed from a case-sensitivity mismatch in the image file names referenced in the documentation. By correcting these typos, the PR ensures that all relevant images are displayed as intended, significantly improving the clarity and completeness of the installation instructions for users. Highlights
Using Gemini Code AssistThe 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
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 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 👍 and 👎 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. Footnotes
|
![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 fixes broken image links in the farmer registry installation guide by correcting typos in the filenames. The changes are correct and address the issue. I've added a couple of suggestions to improve the naming of these image files for better consistency and maintainability within the project's documentation. Adopting a more descriptive naming convention for images would be beneficial.
| 2. In the Apps menu, search for {doc}`spp_base_farmer_registry </reference/modules/spp_base_farmer_registry>` or "OpenSPP Farmer Registry Base" | ||
|
|
||
|  | ||
|  |
There was a problem hiding this comment.
While this change fixes the broken image link, the filename 05-spp_farmer1.jpg is not very descriptive and is inconsistent with other image filenames in the documentation, such as 01-apps-ui.jpg which is more descriptive and uses hyphens. For better maintainability and clarity, consider renaming the image file to something more descriptive, like 05-farmer-registry-search.jpg, and updating the link here accordingly. Using hyphens for separators would also align with the naming of other images.
| 3. Click the **Activate** button to install the module and its dependencies. | ||
|
|
||
|  | ||
|  |
There was a problem hiding this comment.
Similar to the previous image, the filename 06-spp_farmer2.jpg is not very descriptive. For consistency and maintainability, consider renaming it to something like 06-farmer-registry-install-complete.jpg and updating the link here.
|
fix missing screenshots in farmer registry due to typo error in screenshot file name.