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

fix typos in documents #1305

Merged
merged 3 commits into from
Oct 24, 2024
Merged

fix typos in documents #1305

merged 3 commits into from
Oct 24, 2024

Conversation

dheerajsir
Copy link
Contributor

@dheerajsir dheerajsir commented Oct 23, 2024

PR Type

Documentation


Description

This PR addresses several documentation typos and formatting issues:

  • Corrected typos in the installation guide, PR Agent Pro overview, and custom labels documentation.
  • Ensured consistent formatting by adding newlines at the end of files.

Changes walkthrough 📝

Relevant files
Documentation
index.md
Correct typos and formatting in installation guide             

docs/docs/installation/index.md

  • Fixed a typo in the word "your".
  • Ensured consistent formatting with a newline at the end of the file.
  • +2/-2     
    pr_agent_pro.md
    Fix typos and formatting in PR Agent Pro overview               

    docs/docs/overview/pr_agent_pro.md

  • Corrected typos in the words "committing" and "committable".
  • Ensured consistent formatting with a newline at the end of the file.
  • +3/-3     
    custom_labels.md
    Correct typos and formatting in custom labels documentation

    docs/docs/tools/custom_labels.md

  • Fixed a typo in the word "your".
  • Ensured consistent formatting with a newline at the end of the file.
  • +2/-2     

    💡 PR-Agent usage: Comment /help "your question" on any pull request to receive relevant information

    @qodo-merge-pro qodo-merge-pro bot added documentation Improvements or additions to documentation Review effort [1-5]: 1 labels Oct 23, 2024
    Copy link
    Contributor

    PR Reviewer Guide 🔍

    Here are some key observations to aid the review process:

    ⏱️ Estimated effort to review: 1 🔵⚪⚪⚪⚪
    🏅 Score: 95
    🧪 No relevant tests
    🔒 No security concerns identified
    🔀 No multiple PR themes
    ⚡ No major issues detected

    Copy link
    Contributor

    PR Code Suggestions ✨

    Explore these optional code suggestions:

    CategorySuggestion                                                                                                                                    Score
    Enhancement
    Improve link accessibility and SEO by using descriptive link text instead of generic words like "here"

    Consider using a more specific link text for better accessibility and SEO. Instead
    of "here", use descriptive text that indicates the destination of the link.

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

    -1. An OpenAI key from [here](https://platform.openai.com/api-keys), with access to GPT-4 (or a key for other [language models](https://qodo-merge-docs.qodo.ai/usage-guide/changing_a_model/), if you prefer).
    -2. A GitHub\GitLab\BitBucket personal access token (classic), with the repo scope. [GitHub from [here](https://github.com/settings/tokens)]
    +1. An OpenAI key from [OpenAI's API keys page](https://platform.openai.com/api-keys), with access to GPT-4 (or a key for other [language models](https://qodo-merge-docs.qodo.ai/usage-guide/changing_a_model/), if you prefer).
    +2. A GitHub\GitLab\BitBucket personal access token (classic), with the repo scope. [GitHub tokens can be created on the Personal Access Tokens page](https://github.com/settings/tokens)
    • Apply this suggestion
    Suggestion importance[1-10]: 7

    Why: The suggestion improves accessibility and SEO by replacing generic link text with descriptive text, which enhances user experience and search engine indexing.

    7
    Improve clarity of documentation headings by using more specific and descriptive titles

    Consider using a more specific heading for the configuration file section. Instead
    of "Repo configuration file", use a heading that clearly indicates it's about the PR
    Agent configuration file.

    docs/docs/tools/custom_labels.md [27-28]

    -#### 2. Repo configuration file
    +#### 2. PR Agent Repository Configuration File
     To enable custom labels, you need to apply the [configuration changes](#configuration-options) to the local `.pr_agent.toml` file in your repository.
    • Apply this suggestion
    Suggestion importance[1-10]: 5

    Why: The suggestion enhances the clarity of the documentation by providing a more descriptive heading, which helps users quickly understand the content of the section.

    5
    Best practice
    Ensure consistent and correct capitalization of model names in documentation

    Consider using consistent capitalization for the model names. Currently, "GPT4" is
    used, but the more common format is "GPT-4" with a hyphen.

    docs/docs/overview/pr_agent_pro.md [22]

    -| [**Model selection**](https://qodo-merge-docs.qodo.ai/usage-guide/PR_agent_pro_models/)          | Choose the model that best fits your needs, among top models like `GPT4` and `Claude-Sonnet-3.5`
    +| [**Model selection**](https://qodo-merge-docs.qodo.ai/usage-guide/PR_agent_pro_models/)          | Choose the model that best fits your needs, among top models like `GPT-4` and `Claude-Sonnet-3.5`
    • Apply this suggestion
    Suggestion importance[1-10]: 6

    Why: The suggestion ensures consistency and correctness in the documentation, which is important for maintaining a professional and clear presentation of information.

    6
    • Author self-review: I have reviewed the PR code suggestions, and addressed the relevant ones.

    💡 Need additional feedback ? start a PR chat

    @mrT23
    Copy link
    Collaborator

    mrT23 commented Oct 24, 2024

    cool

    @mrT23 mrT23 merged commit 7b5a3d4 into qodo-ai:main Oct 24, 2024
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Labels
    documentation Improvements or additions to documentation Review effort [1-5]: 1
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    2 participants