Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: reorganize installation documentation structure #1475

Merged
merged 3 commits into from
Jan 23, 2025
Merged

docs: reorganize installation documentation structure #1475

merged 3 commits into from
Jan 23, 2025

Conversation

mrT23
Copy link
Collaborator

@mrT23 mrT23 commented Jan 23, 2025

PR Type

Documentation


Description

  • Reorganized installation documentation structure for better clarity.

  • Added a new PR-Agent Installation Guide with detailed platform-specific instructions.

  • Expanded Qodo Merge documentation with installation steps for GitHub, GitLab, and Bitbucket.

  • Updated navigation structure in mkdocs.yml to reflect the new documentation organization.


Changes walkthrough 📝

Relevant files
Documentation
azure.md
Refined Azure DevOps webhook documentation                             

docs/docs/installation/azure.md

  • Adjusted heading level for "Azure DevOps Webhook".
  • Improved clarity in webhook setup instructions.
  • +1/-1     
    bitbucket.md
    Simplified Bitbucket installation documentation                   

    docs/docs/installation/bitbucket.md

  • Removed outdated section on CodiumAI-hosted Bitbucket app.
  • Streamlined Bitbucket installation instructions.
  • +0/-4     
    index.md
    Improved installation index with updated links and instructions

    docs/docs/installation/index.md

  • Updated token acquisition instructions for Git platforms.
  • Renamed integration links for consistency.
  • Updated Qodo Merge link for more accurate details.
  • +6/-6     
    pr_agent.md
    Added detailed PR-Agent installation guide                             

    docs/docs/installation/pr_agent.md

  • Added a new comprehensive guide for PR-Agent installation.
  • Included platform-specific instructions for GitHub, GitLab, Bitbucket,
    and Azure DevOps.
  • +49/-0   
    qodo_merge.md
    Enhanced Qodo Merge installation documentation                     

    docs/docs/installation/qodo_merge.md

  • Expanded Qodo Merge documentation with installation steps for GitHub,
    GitLab, and Bitbucket.
  • Included trial and licensing details for Qodo Merge.
  • Added step-by-step guide for GitLab integration.
  • [link]   
    Configuration changes
    mkdocs.yml
    Updated navigation structure in mkdocs configuration         

    docs/mkdocs.yml

  • Updated navigation structure to include new PR-Agent and Qodo Merge
    guides.
  • Removed redundant links to platform-specific installation files.
  • +2/-6     

    Need help?
  • Type /help how to ... in the comments thread for any question about Qodo Merge usage.
  • Check out the documentation for more information.
  • Copy link
    Contributor

    PR Reviewer Guide 🔍

    Here are some key observations to aid the review process:

    ⏱️ Estimated effort to review: 2 🔵🔵⚪⚪⚪
    🏅 Score: 95
    🧪 No relevant tests
    🔒 No security concerns identified
    ⚡ Recommended focus areas for review

    Broken Link

    The pricing link points to codium.ai/pricing but earlier in the file qodo.ai/pricing is used. Should verify the correct pricing URL is used consistently.

    To use Qodo Merge application on your private Bitbucket Server, you will need to contact us for starting an [Enterprise](https://www.codium.ai/pricing/) trial.

    Copy link
    Contributor

    qodo-merge-pro-for-open-source bot commented Jan 23, 2025

    PR Code Suggestions ✨

    Explore these optional code suggestions:

    CategorySuggestion                                                                                                                                    Score
    Possible issue
    ✅ Update outdated domain reference

    The GitLab webhook URL is hardcoded to use 'codium.ai' domain which appears outdated
    since the product is now called 'Qodo Merge' and uses 'qodo.ai' domain.

    docs/docs/installation/qodo_merge.md [67]

    -URL: https://pro.gitlab.pr-agent.codium.ai/webhook
    +URL: https://pro.gitlab.pr-agent.qodo.ai/webhook

    [Suggestion has been applied]

    Suggestion importance[1-10]: 9

    Why: This is a critical fix as it updates an outdated domain reference that could cause the webhook integration to fail. The URL needs to match the new branding and domain structure.

    9
    General
    ✅ Clarify token requirements

    The token acquisition instructions should be more specific about which Git platform
    token is needed. Currently it's unclear if users need tokens for all platforms or
    just their specific one.

    docs/docs/installation/index.md [7]

    -2. A Git personal access token, with the repo scope (GitHub token can be issued from for example [here](https://github.com/settings/tokens){:target="_blank"})
    +2. A personal access token from your Git platform (GitHub, GitLab, BitBucket, or Azure DevOps) with repo scope. For example, GitHub tokens can be created [here](https://github.com/settings/tokens){:target="_blank"}

    [Suggestion has been applied]

    Suggestion importance[1-10]: 7

    Why: The suggestion improves clarity by explicitly stating which Git platforms are supported and that users only need a token for their specific platform, reducing potential confusion for new users.

    7

    @mrT23 mrT23 merged commit b320767 into main Jan 23, 2025
    2 checks passed
    @mrT23 mrT23 deleted the tr/docs24 branch January 23, 2025 06:53
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    1 participant