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

update docs #1342

Merged
merged 1 commit into from
Nov 4, 2024
Merged

update docs #1342

merged 1 commit into from
Nov 4, 2024

Conversation

hussam789
Copy link
Collaborator

@hussam789 hussam789 commented Nov 4, 2024

PR Type

Documentation


Description

  • Updated the documentation to provide clearer instructions for Jira integration, including a direct link to the relevant section.
  • Clarified the instructions for adding Personal Access Tokens in configuration files.
  • Improved the readability of the core abilities list by adding a new line.

Changes walkthrough 📝

Relevant files
Documentation
fetching_ticket_context.md
Update Jira integration instructions and configuration details

docs/docs/core-abilities/fetching_ticket_context.md

  • Updated link format for Jira integration instructions.
  • Clarified configuration file instructions for adding PAT.
  • +2/-2     
    Formatting
    index.md
    Improve readability of core abilities list                             

    docs/docs/core-abilities/index.md

    • Added a new line for better readability.
    +1/-0     

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

    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 major issues detected

    Copy link
    Contributor

    PR Code Suggestions ✨

    Explore these optional code suggestions:

    CategorySuggestion                                                                                                                                    Score
    Best practice
    Use relative links for internal documentation references to improve maintainability

    Consider using a relative link instead of an absolute URL for internal documentation
    references. This makes it easier to maintain the documentation and ensures links
    work correctly in different environments.

    docs/docs/core-abilities/fetching_ticket_context.md [12]

    -2. For Jira tickets, you should follow the instructions in [Jira Integration](https://qodo-merge-docs.qodo.ai/core-abilities/fetching_ticket_context/#jira-integration) in order to authenticate with Jira.
    +2. For Jira tickets, you should follow the instructions in [Jira Integration](#jira-integration) in order to authenticate with Jira.
    • Apply this suggestion
    Suggestion importance[1-10]: 7

    Why: Using relative links for internal documentation is a good practice as it improves maintainability and ensures links work correctly across different environments. This change would make the documentation more robust.

    7
    Enhancement
    Provide more specific guidance on configuration file location to improve clarity

    Provide more specific guidance on where to add the configuration lines. Mentioning
    "Configuration file/Environment variables/Secrets file" might be too vague for some
    users.

    docs/docs/core-abilities/fetching_ticket_context.md [109]

    -2. In your Configuration file/Environment variables/Secrets file, add the following lines:
    +2. Add the following lines to your configuration file (e.g., `config.toml`), environment variables, or secrets file, depending on your setup:
    • Apply this suggestion
    Suggestion importance[1-10]: 6

    Why: The suggestion provides more specific guidance on where to add configuration lines, which can help users better understand where to make changes. This improves clarity and reduces potential confusion.

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

    💡 Need additional feedback ? start a PR chat

    @mrT23 mrT23 merged commit bf3ebbb into main Nov 4, 2024
    2 checks passed
    @mrT23 mrT23 deleted the hl/docs_tickets branch November 4, 2024 15:20
    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.

    2 participants