Skip to content

Improve Markdown format in model configuration guide #1693

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

Conversation

PeterDaveHello
Copy link
Contributor

@PeterDaveHello PeterDaveHello commented Apr 12, 2025

User description

Enhance documentation readability by:

  • Adding TOML language identifiers to enable syntax highlighting
  • Adjusting spacing and formatting for proper Markdown rendering

These improvements make the guide easier to follow.


PR Type

Documentation


Description

  • Added toml syntax highlighting for code blocks in Markdown.

  • Improved spacing and formatting for better readability.

  • Enhanced documentation clarity for model configuration instructions.


Changes walkthrough 📝

Relevant files
Documentation
changing_a_model.md
Improved Markdown formatting and syntax highlighting         

docs/docs/usage-guide/changing_a_model.md

  • Added toml syntax highlighting to code blocks.
  • Adjusted spacing for consistent formatting.
  • Improved clarity in configuration instructions and examples.
  • Enhanced readability of model-specific setup details.
  • +44/-23 

    Need help?
  • Type /help how to ... in the comments thread for any questions about Qodo Merge usage.
  • Check out the documentation for more information.
  • Enhance documentation readability by:
    - Adding TOML language identifiers to enable syntax highlighting
    - Adjusting spacing and formatting for proper Markdown rendering
    
    These improvements make the guide easier to follow.
    Copy link
    Contributor

    PR Reviewer Guide 🔍

    Here are some key observations to aid the review process:

    ⏱️ Estimated effort to review: 1 🔵⚪⚪⚪⚪
    🧪 No relevant tests
    🔒 No security concerns identified
    ⚡ No major issues detected

    Copy link
    Contributor

    PR Code Suggestions ✨

    Explore these optional code suggestions:

    CategorySuggestion                                                                                                                                    Impact
    Possible issue
    Remove incorrect closing parenthesis

    The closing parenthesis after the JSON string is incorrect and should be
    removed. This is likely a copy-paste error from code documentation.

    docs/docs/usage-guide/changing_a_model.md [44]

    -extra_headers='{"projectId": "<authorized projectId >", ...}') #The value of this setting should be a JSON string representing the desired headers, a ValueError is thrown otherwise.
    +extra_headers='{"projectId": "<authorized projectId >", ...}' #The value of this setting should be a JSON string representing the desired headers, a ValueError is thrown otherwise.
    • Apply this suggestion
    Suggestion importance[1-10]: 9

    __

    Why: The suggestion correctly identifies a syntax error in the configuration example. The extra closing parenthesis would cause a TOML parsing error if users copy this example directly. This is a high-impact fix as it prevents a functional error that would block users from successfully configuring custom headers.

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

    @PeterDaveHello
    Copy link
    Contributor Author

    See here for the current not correct result, especially the button ones:

    https://qodo-merge-docs.qodo.ai/usage-guide/changing_a_model/

    @mrT23 mrT23 merged commit 7d00574 into qodo-ai:main Apr 14, 2025
    2 checks passed
    @PeterDaveHello PeterDaveHello deleted the ImproveMarkdownForChangingAModelGuide branch April 14, 2025 18:25
    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