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: add links to technical blogs on LLMs and coding tasks in core a… #1271

Merged
merged 2 commits into from
Oct 6, 2024

Conversation

mrT23
Copy link
Collaborator

@mrT23 mrT23 commented Oct 6, 2024

User description

…bilities index


PR Type

Documentation, Enhancement


Description

  • Added a new "Blogs" section to the core abilities index document
  • Included five technical blog links from Qodo, focusing on LLMs and coding tasks
  • Enhanced the document with additional resources for deeper insights into LLM capabilities in software development
  • Preserved existing content, including the list of core abilities

Changes walkthrough 📝

Relevant files
Documentation
index.md
Add technical blog links to core abilities index                 

docs/docs/core-abilities/index.md

  • Added a new "Blogs" section with an introductory paragraph
  • Listed five technical blog links from Qodo related to LLMs and coding
    tasks
  • Maintained existing content, including the list of core abilities
  • +13/-1   

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

    @codiumai-pr-agent-pro codiumai-pr-agent-pro bot added documentation Improvements or additions to documentation enhancement New feature or request Review effort [1-5]: 1 labels Oct 6, 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
    ⚡ Recommended focus areas for review

    Content Consistency
    Ensure that the new "Blogs" section aligns with the document's overall structure and purpose

    Copy link
    Contributor

    codiumai-pr-agent-pro bot commented Oct 6, 2024

    PR Code Suggestions ✨

    Explore these optional code suggestions:

    CategorySuggestion                                                                                                                                    Score
    Enhancement
    ✅ Organize blog links into categories for improved navigation and readability

    Consider grouping the blog links into categories based on their topics. This will
    help readers quickly find articles related to specific areas of interest, such as
    code generation, development processes, or cost optimization.

    docs/docs/core-abilities/index.md [14-24]

     ## Blogs
     
     Here are some additional technical blogs from Qodo, that delve deeper into the core capabilities and features of Large Language Models (LLMs) when applied to coding tasks. 
     These resources provide more comprehensive insights into leveraging LLMs for software development.
     
    +### Code Generation and LLMs
    +- [State-of-the-art Code Generation with AlphaCodium – From Prompt Engineering to Flow Engineering](https://www.qodo.ai/blog/qodoflow-state-of-the-art-code-generation-for-code-contests/)
    +- [RAG for a Codebase with 10k Repos](https://www.qodo.ai/blog/rag-for-large-scale-code-repos/)
     
    -- [State-of-the-art Code Generation with AlphaCodium – From Prompt Engineering to Flow Engineering](https://www.qodo.ai/blog/qodoflow-state-of-the-art-code-generation-for-code-contests/)
    +### Development Processes
     - [Understanding the Challenges and Pain Points of the Pull Request Cycle](https://www.qodo.ai/blog/understanding-the-challenges-and-pain-points-of-the-pull-request-cycle/)
    -- [RAG for a Codebase with 10k Repos](https://www.qodo.ai/blog/rag-for-large-scale-code-repos/)
     - [Introduction to Code Coverage Testing](https://www.qodo.ai/blog/introduction-to-code-coverage-testing/)
    +
    +### Cost Optimization
     - [Reduce Your Costs by 30% When Using GPT for Python Code](https://www.qodo.ai/blog/reduce-your-costs-by-30-when-using-gpt-3-for-python-code/)

    [Suggestion has been applied]

    Suggestion importance[1-10]: 8

    Why: This suggestion significantly improves the structure and organization of the blog section. By grouping related topics, it enhances navigation and makes it easier for readers to find relevant content, which is particularly valuable as the list of resources grows.

    8
    Add brief descriptions to each blog link to provide more context for readers

    Consider adding a brief description or key takeaway for each blog link. This will
    give readers a quick overview of what to expect from each article, making it easier
    for them to decide which ones are most relevant to their interests or needs.

    docs/docs/core-abilities/index.md [20-24]

    -- [State-of-the-art Code Generation with AlphaCodium – From Prompt Engineering to Flow Engineering](https://www.qodo.ai/blog/qodoflow-state-of-the-art-code-generation-for-code-contests/)
    -- [Understanding the Challenges and Pain Points of the Pull Request Cycle](https://www.qodo.ai/blog/understanding-the-challenges-and-pain-points-of-the-pull-request-cycle/)
    -- [RAG for a Codebase with 10k Repos](https://www.qodo.ai/blog/rag-for-large-scale-code-repos/)
    -- [Introduction to Code Coverage Testing](https://www.qodo.ai/blog/introduction-to-code-coverage-testing/)
    -- [Reduce Your Costs by 30% When Using GPT for Python Code](https://www.qodo.ai/blog/reduce-your-costs-by-30-when-using-gpt-3-for-python-code/)
    +- [State-of-the-art Code Generation with AlphaCodium – From Prompt Engineering to Flow Engineering](https://www.qodo.ai/blog/qodoflow-state-of-the-art-code-generation-for-code-contests/) - Explores advanced techniques in AI-driven code generation.
    +- [Understanding the Challenges and Pain Points of the Pull Request Cycle](https://www.qodo.ai/blog/understanding-the-challenges-and-pain-points-of-the-pull-request-cycle/) - Analyzes common issues in the PR process and potential solutions.
    +- [RAG for a Codebase with 10k Repos](https://www.qodo.ai/blog/rag-for-large-scale-code-repos/) - Discusses implementing Retrieval-Augmented Generation for large-scale codebases.
    +- [Introduction to Code Coverage Testing](https://www.qodo.ai/blog/introduction-to-code-coverage-testing/) - Provides an overview of code coverage testing and its importance in software development.
    +- [Reduce Your Costs by 30% When Using GPT for Python Code](https://www.qodo.ai/blog/reduce-your-costs-by-30-when-using-gpt-3-for-python-code/) - Offers strategies to optimize costs when using GPT models for Python development.
    • Apply this suggestion
    Suggestion importance[1-10]: 7

    Why: This suggestion enhances readability and user experience by providing quick overviews of each blog post. It helps readers quickly determine which articles are most relevant to their interests, improving the overall usefulness of the resource list.

    7

    💡 Need additional feedback ? start a PR chat

    Co-authored-by: codiumai-pr-agent-pro[bot] <151058649+codiumai-pr-agent-pro[bot]@users.noreply.github.com>
    @mrT23 mrT23 merged commit 6459535 into main Oct 6, 2024
    2 checks passed
    @mrT23 mrT23 deleted the tr/blogs branch October 6, 2024 15:20
    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 enhancement New feature or request Review effort [1-5]: 1
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    2 participants