feat: ✨ images and updated docs

docs/docs/license-editor.md

@@ -13,3 +13,7 @@ head:
 The license editor is a user-friendly interface that allows you to edit the license of your research software. The license editor is designed to help you input and update the license of your research software in a simple and intuitive way.
 
 The license editor provides you with a list of common licenses that you can choose from. Once selected the license content is displayed in the editor allowing you to review and update the license text. The license editor also provides you with a preview of the license text to help you understand how the license will be displayed in your repository.
+
+![License Editor](/license-editor.png)
+The image above demonstrates the License Editor in the Codefair UI.
+A license is selected from the dropdown list, and the license text is displayed in the editor. The license text is displayed in the preview section to help you understand how the license will be displayed in your repository.

docs/docs/license-issue.md

@@ -13,3 +13,10 @@ head:
 The absence of a license file is a common issue in repositories. This problem occurs when a repository does not include a LICENSE file, which contains the licensing information for the repository. The LICENSE file is crucial because it informs users about how they can use the code in the repository. Additionally, it helps protect the code.
 
 Without a LICENSE file, users may be uncertain about how to use the repository's code. Adding a LICENSE file resolves this issue, making the code more accessible and usable. Addressing the LICENSE issue is important as it enhances the repository's compliance with FAIR principles and is a necessary step before checking other compliances. By fixing this issue, you contribute to making your repository more FAIR and aligned with FAIR4RS principles.
+
+## How to fix the LICENSE issue
+
+To fix the LICENSE issue, you can simply click on the button provided in the Issue Dashboard. This button will direct you to the Codefair UI to select and edit the LICENSE file. Once you have selected the appropriate license, you can save and push the changes to your repository. This will open a pull request in your repository with the updated LICENSE file. You can then review the changes and merge the pull request to resolve the LICENSE issue.
+
+![LICENSE Issue](/license-issue-dashboard.png)
+The image above demonstrates the LICENSE issue in the Issue Dashboard.

docs/docs/metadata-editor.md

@@ -10,4 +10,18 @@ head:
 
 # Metadata Editor
 
-The metadata editor is a user-friendly interface that allows you to edit the metadata of your research software. The metadata editor is designed to help you input and update the metadata of your research software in a simple and intuitive way.
+The metadata editor is a user-friendly interface that allows you to edit the metadata of your research software. The metadata initially displayed is what Probot has gathered from your repository. The editor is designed to help you input and update the metadata of your research software in a simple and intuitive way.
+
+The editor is broken into sections, each representing a different aspect of the metadata:
+
+1. **General Information**: This section includes the title, description, and homepage of your repository.
+2. **Discoverability**: This section includes the keywords and topics associated with your repository.
+3. **License**: This section includes the license information for your repository.
+4. **Software Requirements**: This section includes the software requirements for your repository.
+5. **Current Version**: This section includes the version number and release date of your repository.
+6. **Additional Information**: This section includes any additional information you would like to include in your metadata.
+7. **Editorial Review**: This section includes the status of the metadata and any comments from the editorial review.
+8. **Authors and Contributors**: This section includes the authors and contributors of your repository.
+
+![Metadata Editor](/metadata-editor.png)
+The image above demonstrates the Metadata Editor in the Codefair UI.

docs/docs/metadata-issue.md

@@ -13,3 +13,14 @@ head:
 The Metadata issue occurs when a CITATION.cff or codemeta.json file is not present in the repository. Metadata is essential for enhancing the discoverability and reusability of your research software. These files provide crucial information about your software, including the authors, title, and license details. This information is important for users who want to cite your research software or reuse it in their own projects.
 
 By adding a CITATION.cff and codemeta.json file to your repository, you can help make your research software more discoverable and reusable. By adding metadata to your repository, you can help make your research software more FAIR and more compliant with the FAIR4RS principles.
+
+::: info
+Metadata checks are performed only when a LICENSE file is present in the repository.
+:::
+
+## How to fix the Metadata issue
+
+To fix the Metadata issue, you can simply click on the button provided in the Issue Dashboard under the Metadata section. This will direct you to the Codefair UI to review the metadata gathered from Probot. You can then edit the metadata as needed and save and push the changes. This will open a pull request in your repository with the updated metadata files. You can then review the changes and merge the pull request to resolve the Metadata issue.
+
+![Metadata Issue](/metadata-issue-dashboard.png)
+The image above demonstrates the Metadata issue in the Issue Dashboard.