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: update FAQ with new questions and improve formatting #1430

Merged
merged 2 commits into from
Jan 1, 2025
Merged

Conversation

mrT23
Copy link
Collaborator

@mrT23 mrT23 commented Jan 1, 2025

PR Type

Documentation


Description

  • Added new FAQs about draft PRs and effort calibration

  • Standardized question format with 'Q:' prefix

  • Fixed typos and improved text clarity

  • Enhanced self-hosting and open-source documentation details


Changes walkthrough 📝

Relevant files
Documentation
index.md
FAQ updates and additions with formatting improvements     

docs/docs/faq/index.md

  • Standardized question format by adding 'Q:' prefix
  • Added new FAQ entries about draft PR reviews and effort calibration
  • Fixed minor typos and improved text clarity
  • Enhanced self-hosting and open-source information
  • +32/-9   

    💡 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

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

    PR Code Suggestions ✨

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

    Previous suggestions

    ✅ Suggestions up to commit 0ec4491
    CategorySuggestion                                                                                                                                    Score
    General
    ✅ Remove unnecessary whitespace before punctuation mark

    Remove the extra space before the question mark in the FAQ title about code storage.

    docs/docs/faq/index.md [50]

    -??? note "Q: Will you store my code ? Are you using my code to train models?"
    +??? note "Q: Will you store my code? Are you using my code to train models?"

    [Suggestion has been applied]

    Suggestion importance[1-10]: 3

    Why: The suggestion correctly identifies an extra space before the question mark, which affects readability. While valid, this is a minor formatting issue with low impact on documentation quality.

    3

    Co-authored-by: qodo-merge-pro-for-open-source[bot] <189517486+qodo-merge-pro-for-open-source[bot]@users.noreply.github.com>
    @mrT23 mrT23 merged commit 04197a9 into main Jan 1, 2025
    2 checks passed
    @mrT23 mrT23 deleted the tr/faq_update branch January 1, 2025 07:30
    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