You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Provide more context about CodiumAI's commands for testing the installation
Consider adding a brief explanation of what CodiumAI's commands are or where users can find a list of these commands. This would provide more context for users testing the installation.
-6. Test your installation by opening a merge request or commenting or a merge request using one of CodiumAI's commands.+6. Test your installation by opening a merge request or commenting on a merge request using one of CodiumAI's commands. You can find a list of available commands in our [documentation](link-to-commands-doc).
Apply this suggestion
Suggestion importance[1-10]: 9
Why: This suggestion significantly enhances the user experience by providing additional context and guidance, which is crucial for new users setting up the system.
9
Best practice
Use standard three backticks for code block formatting in Markdown
The code block for the webhook URL is using four backticks instead of three, which is non-standard in Markdown. Consider using three backticks for proper code block formatting.
-5. Create a webhook in GitLab. Set the URL to ````http[s]://<PR_AGENT_HOSTNAME>/webhook````. Set the secret token to the generated secret from step 2.+5. Create a webhook in GitLab. Set the URL to ```http[s]://<PR_AGENT_HOSTNAME>/webhook```. Set the secret token to the generated secret from step 2.
Apply this suggestion
Suggestion importance[1-10]: 8
Why: This suggestion corrects a formatting issue that could cause rendering problems in some Markdown viewers, improving the overall documentation quality.
8
Clarity
Use a more descriptive placeholder for the server hostname in the webhook URL
Consider using a more specific placeholder for the hostname in the webhook URL. Instead of <PR_AGENT_HOSTNAME>, you could use something like <YOUR_PR_AGENT_SERVER> to make it clearer that users need to replace this with their own server address.
-5. Create a webhook in GitLab. Set the URL to ````http[s]://<PR_AGENT_HOSTNAME>/webhook````. Set the secret token to the generated secret from step 2.+5. Create a webhook in GitLab. Set the URL to ````http[s]://<YOUR_PR_AGENT_SERVER>/webhook````. Set the secret token to the generated secret from step 2.
Apply this suggestion
Suggestion importance[1-10]: 7
Why: The suggestion improves clarity by using a more specific placeholder, making it clearer for users to understand what information they need to provide.
Use standard three backticks for code block formatting in Markdown
The code block for the webhook URL is using four backticks instead of three, which is non-standard in Markdown. Consider using three backticks for proper code block formatting.
-5. Create a webhook in GitLab. Set the URL to ````http[s]://<PR_AGENT_HOSTNAME>/webhook````. Set the secret token to the generated secret from step 2.+5. Create a webhook in GitLab. Set the URL to ```http[s]://<PR_AGENT_HOSTNAME>/webhook```. Set the secret token to the generated secret from step 2.
Apply this suggestion
Suggestion importance[1-10]: 8
Why: This suggestion corrects a formatting issue that could cause rendering problems in some Markdown viewers, improving the overall documentation quality.
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
PR Type
Documentation
Description
http[s]://<PR_AGENT_HOSTNAME>/webhook
Changes walkthrough 📝
gitlab.md
Clarify webhook URL format for GitLab integration
docs/docs/installation/gitlab.md