Skip to content

Update README with new features and links#1106

Open
scosman wants to merge 2 commits intomainfrom
scosman/update_readme_060326
Open

Update README with new features and links#1106
scosman wants to merge 2 commits intomainfrom
scosman/update_readme_060326

Conversation

@scosman
Copy link
Collaborator

@scosman scosman commented Mar 6, 2026

Note

Low Risk
Documentation-only changes to README.md that update links and marketing copy, with no impact on runtime code or behavior.

Overview
Updates README feature navigation and highlights optimization features. Adds a new top-of-page docs link for Prompt Optimizer.

Refreshes the Key Features list by adding an Optimizers bullet and updating the Fine Tuning bullet’s wording/models, cleaning up the feature list presentation.

Written by Cursor Bugbot for commit fc9ed64. This will update automatically on new commits. Configure here.

Summary by CodeRabbit

  • Documentation
    • Added Prompt Optimizer navigation link in the header
    • Introduced new Optimizers documentation page to help users find the best prompt, model, or fine-tuning approach
    • Updated Fine Tuning documentation with expanded example models including Qwen, GPT, and Gemini

@gemini-code-assist
Copy link
Contributor

Summary of Changes

Hello, I'm Gemini Code Assist1! 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 enhances the project's README.md by integrating new feature announcements and updating existing descriptions. The changes aim to improve user awareness of recently added capabilities, such as the Prompt Optimizer and general Optimizers, and ensure the documentation accurately reflects the current state of the fine-tuning service.

Highlights

  • README Navigation: Added a new link for "Prompt Optimizer" to the central navigation section.
  • New Feature Introduction: Introduced "Optimizers" as a new key feature, detailing its purpose to find the best prompt, model, or fine-tune.
  • Fine Tuning Description Update: Updated the description for the "Fine Tuning" feature to reflect support for a broader range of models (Qwen, GPT, Gemini) and removed specific mentions of Llama and GPT-4o.

🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console.

Changelog
  • README.md
    • Added a link to the "Prompt Optimizer" documentation in the header navigation.
    • Introduced a new section for "Optimizers" with a description and link.
    • Revised the description for "Fine Tuning" to list updated model support.
Activity
  • No human activity has been recorded for this pull request yet.
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.

Copy link
Contributor

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request updates the README.md file to include new features, specifically 'Prompt Optimizer' and 'Optimizers', and updates the description for 'Fine Tuning'. The changes are mostly good, but I've identified a minor issue with a link that could improve user navigation. My review includes a suggestion to make a link more specific and consistent with others in the document.

Note: Security Review has been skipped due to the limited scope of the PR.

README.md Outdated
- 🚀 [**Intuitive Desktop Apps**](https://kiln.tech/download): One-click apps for Windows, MacOS, and Linux.
- 📊 [**Evals**](https://docs.kiln.tech/docs/evaluations): Evaluate the quality of your models/tasks using state of the art evaluators.
- 🎛️ [**Fine Tuning**](https://docs.kiln.tech/docs/fine-tuning-guide): Zero-code fine-tuning for Llama, GPT-4o, and more. Automatic serverless deployment of models.
- 📈 [**Optimizers**](https://kiln.tech/download): Find the best prompt, model or fine-tune for your task. Improve quality and lower costs.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

The link for the 'Optimizers' feature points to the general download page. For consistency with other features in this list which link to specific documentation pages (e.g., 'Evals', 'Fine Tuning'), and to improve user experience, consider linking to a more specific documentation page. The 'Prompt Optimizer' documentation link added elsewhere in this PR could be a more suitable target.

Suggested change
- 📈 [**Optimizers**](https://kiln.tech/download): Find the best prompt, model or fine-tune for your task. Improve quality and lower costs.
- 📈 [**Optimizers**](https://docs.kiln.tech/docs/prompts/automatic-prompt-optimizer): Find the best prompt, model or fine-tune for your task. Improve quality and lower costs.

@scosman scosman requested a review from sfierro March 6, 2026 16:01
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Mar 6, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Repository UI

Review profile: CHILL

Plan: Pro

Run ID: ebf752de-da9d-430c-9627-4ab2ee2cf3c0

📥 Commits

Reviewing files that changed from the base of the PR and between f18aa3b and fc9ed64.

📒 Files selected for processing (1)
  • README.md

Walkthrough

The README.md was updated to introduce new navigation structure. A "Prompt Optimizer" link was added to the header navigation. The Fine Tuning section was restructured to include a new "Optimizers" entry alongside an updated "Fine Tuning" entry with revised example models (Qwen, GPT, Gemini replacing Llama references). Minor formatting adjustments were made for consistency.

Changes

Cohort / File(s) Summary
Documentation Navigation Update
README.md
Added "Prompt Optimizer" navigation item; restructured Fine Tuning section into separate Optimizers and Fine Tuning entries; updated example model references from Llama to Qwen, GPT, and Gemini; minor formatting adjustments (+3/-1 lines).

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Possibly related PRs

  • New README #555 — Both PRs modify README navigation/header links and reorganize navigation items including Fine Tuning entries.

Suggested reviewers

  • leonardmq

Poem

🐰 A hop, skip, and update to docs so fine,
New Optimizers join the navigation line!
Prompt Optimizer hops in with cheer,
Qwen, GPT, Gemini now appear,
README refreshed, the path is clear! ✨

🚥 Pre-merge checks | ✅ 2 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Description check ⚠️ Warning The description is missing required sections from the template: 'What does this PR do?' structured section, 'Related Issues', and the contributor checklist items. Add the missing template sections: structure 'What does this PR do?' as a proper section, include 'Related Issues' with any linked issues, and complete the contributor checklist with test confirmation and agreement confirmation.
✅ Passed checks (2 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately describes the main changes: updating the README with new features and links including the Prompt Optimizer and Optimizers entry.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch scosman/update_readme_060326

Tip

Try Coding Plans. Let us write the prompt for your AI agent so you can ship faster (with fewer bugs).
Share your feedback on Discord.


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@github-actions
Copy link

github-actions bot commented Mar 6, 2026

📊 Coverage Report

Overall Coverage: 91%

Diff: origin/main...HEAD

No lines with coverage information in this diff.


Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants