README.md updates for monorepo

[ericcurtin]

Now that we have consolidated into one repo, we can reword some details to reflect that.

Also trying to trim so fat.

Summary by Sourcery

Update README.md to reflect the consolidated monorepo structure and streamline project documentation

Documentation:

• Revise project description to highlight Docker Model Runner features and monorepo consolidation
• Remove outdated sections including detailed contributing guide and architecture overview

[sourcery-ai]

Reviewer's guide (collapsed on small PRs)

Reviewer's Guide

The PR streamlines the README by consolidating content for a monorepo setup, removing outdated sections, and rephrasing the project description to reflect Docker Model Runner’s unified experience.

File-Level Changes

Change	Details	Files
Streamlined README to reflect monorepo consolidation	Rewrote project description to focus on Docker Model Runner features Removed legacy architecture and external repo links sections Eliminated outdated Contributing and component overview content Simplified overview and prerequisites information	README.md

---

Tips and commands

Interacting with Sourcery

• Trigger a new review: Comment @sourcery-ai review on the pull request.
• Continue discussions: Reply directly to Sourcery's review comments.
• Generate a GitHub issue from a review comment: Ask Sourcery to create an
  issue from a review comment by replying to it. You can also reply to a
  review comment with @sourcery-ai issue to create an issue from it.
• Generate a pull request title: Write @sourcery-ai anywhere in the pull
  request title to generate a title at any time. You can also comment
  @sourcery-ai title on the pull request to (re-)generate the title at any time.
• Generate a pull request summary: Write @sourcery-ai summary anywhere in
  the pull request body to generate a PR summary at any time exactly where you
  want it. You can also comment @sourcery-ai summary on the pull request to
  (re-)generate the summary at any time.
• Generate reviewer's guide: Comment @sourcery-ai guide on the pull
  request to (re-)generate the reviewer's guide at any time.
• Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
  pull request to resolve all Sourcery comments. Useful if you've already
  addressed all the comments and don't want to see them anymore.
• Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
  request to dismiss all existing Sourcery reviews. Especially useful if you
  want to start fresh with a new review - don't forget to comment
  @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

• Enable or disable review features such as the Sourcery-generated pull request
  summary, the reviewer's guide, and others.
• Change the review language.
• Add, remove or edit custom review instructions.
• Adjust other review settings.

Getting Help

• Contact our support team for questions or feedback.
• Visit our documentation for detailed guides and information.
• Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.

[Copilot]

Pull Request Overview

This PR updates the README.md to reflect the consolidation into a monorepo structure and streamlines the documentation by removing redundant information. The changes align the documentation with the new unified repository approach while making it more concise.

Key changes:

• Updated project description to be more comprehensive and user-focused
• Removed references to separate repositories now that components are consolidated
• Eliminated redundant sections and development warnings

---

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

[gemini-code-assist]

Summary of Changes

Hello @ericcurtin, I'm Gemini Code Assist¹! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request focuses on refining the README.md to align with the project's new monorepo structure. The changes aim to provide a more accurate and streamlined introduction to the Docker Model Runner, emphasizing its core functionalities and supported platforms, while removing outdated or overly detailed information.

Highlights

• README.md Update: The README.md file has been significantly updated to reflect the project's consolidation into a monorepo and to provide a more concise and current overview of the Docker Model Runner.
• Enhanced Project Description: The introductory section now offers a clearer and more comprehensive description of Docker Model Runner (DMR), highlighting its purpose in managing, running, and deploying AI models using Docker, including LLMs.
• Content Streamlining: Several sections, including the 'NOTE' about API stability, detailed explanations of standalone mode, 'Contributing - Building from Source', and 'Architecture Overview', have been removed to 'trim the fat' and simplify the document.
• Broader Platform Support: The overview now explicitly states that the package supports Docker Model Runner in both Docker Desktop and Docker Engine, broadening the scope from just Docker Desktop.

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature	Command	Description
Code Review	/gemini review	Performs a code review for the current pull request in its current state.
Pull Request Summary	/gemini summary	Provides a summary of the current pull request in its current state.
Comment	@gemini-code-assist	Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help	/gemini help	Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

[sourcery-ai]

Hey there - I've reviewed your changes and they look great!

---

Sourcery is free for open source - if you like our reviews please consider sharing them ✨

• X
• Mastodon
• LinkedIn
• Facebook

_{Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.}

[ericcurtin]

Stating this repo specifically as a backend, doesn't make sense anymore as this is a complete repo for all of DMR.

[gemini-code-assist]

Code Review

This pull request updates the README.md to reflect the project's new monorepo structure. The changes simplify the introduction and remove outdated information about separate repositories. My review focuses on ensuring that important context for contributors and users is not lost in the process of trimming the content. I've suggested re-adding a stability warning if the API is still unstable, and restoring a concise architecture overview to help orient new contributors to the project's components.

[ericcurtin]

We went GA so some of these things are not necessary.

We only mentioned support for Docker Desktop in the past on this README.md, which is misleading.

"This guide is for external contributors". All contributors should be treated the same.