Uh oh!
There was an error while loading. Please reload this page.
Add link to OpenLOCK specs to docs - #23
Conversation
There was a problem hiding this comment.
Summary of Changes
Hello @Maismaus, 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 enhances the project's documentation by adding a crucial link to the OpenLOCK specifications within the sets/README.md file. The primary goal is to clarify the meaning behind the letter naming conventions used in various filenames, addressing potential confusion for users and making the documentation more comprehensive and self-sufficient. This change directly improves the discoverability of important external specifications relevant to the project's file structure.
Highlights
- Documentation Update: A new entry has been added to the
sets/README.mdfile to explain the 'letter naming scheme (I, E, etc.)' used in filenames. This entry clarifies that these letters follow the OpenLOCK specifications and provides a direct link to the relevant documentation on the Printablescenery website.
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 in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.
| 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 issue 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 👍 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
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. ↩
There was a problem hiding this comment.
Code Review
This pull request adds a helpful link to the OpenLOCK specifications to explain the letter-based naming scheme for tiles, which is a great addition to the documentation based on your query. I've provided one suggestion to make the link text more descriptive, which is a best practice for accessibility and readability.
| * dragonlock - has dragonbite clip holes at vertices | ||
| * magnetic.dragonlock - has dragonbite clip holes at vertices and holes for 5mm magnets at edges | ||
| * magnetic.dragonlock - has dragonbite clip holes at vertices and holes for 5mm magnets at edges | ||
| * letter naming scheme (I, E, etc.) - follows the OpenLock specifications, see [here](https://www.printablescenery.com/product/open-lock/). |
There was a problem hiding this comment.
For better readability and accessibility, it's good practice to use descriptive link text instead of a generic term like "here". This helps users know where a link will take them.
| * letter naming scheme (I, E, etc.) - follows the OpenLock specifications, see [here](https://www.printablescenery.com/product/open-lock/). | |
| * letter naming scheme (I, E, etc.) - follows the [OpenLock specifications](https://www.printablescenery.com/product/open-lock/). |
I wondered what the letters in the filenames meant, but couldn't find it in the docs.