[Docs] Permission Keys Reference: Add callout to relevant contributing page #15559
Conversation
… page Signed-off-by: Siddhi sahu <himanisahu739@gmail.com>
There was a problem hiding this comment.
Summary of Changes
Hello @Siddhi-sahu, 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!
I've updated the Permission Keys Reference documentation page to include a new callout. This addition aims to improve user guidance by providing a direct link to the Authorization Extensibility Documentation, specifically for those interested in understanding or contributing to permission keys. The change helps clarify how Meshery's authorization system works and how to modify or add new permission keys.
Highlights
- Documentation Enhancement: Added a new information callout to the
Permission Keys Referencepage (docs/pages/reference/permissions.md). This callout directs users to theAuthorization Extensibility Documentationfor details on contributing to permission keys.
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 or fill out our survey to provide feedback.
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 callout to the permissions reference page, directing users to the documentation on how to contribute permission keys. This is a valuable addition for contributors. I have one suggestion to improve the wording in the new alert box for better readability.
|
|
|
🚀 Preview for commit 628dac5 at: https://6895ba71ff37d2e9e1e339e1--meshery-docs-preview.netlify.app |
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com> Signed-off-by: Lee Calcote <leecalcote@gmail.com>
|
🚀 Preview for commit a8b2cc0 at: https://6896653df3c2f20e48a2ea36--meshery-docs-preview.netlify.app |
|
Thanks! |
Notes for Reviewers
before:
after:
Signed commits