Conversation
Summary of ChangesHello, 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 establishes a robust and centralized documentation system for the Highlights
🧠 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
Ignored Files
Using Gemini Code AssistThe 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
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 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
|
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request introduces a comprehensive documentation site for the evals project, built with Sphinx. It includes guides, reference material, and contribution guidelines. The changes are extensive, adding many new markdown files, a Sphinx configuration, a Makefile for building the docs, and a Dart script for auto-generating API documentation.
My review has focused on the structure and correctness of the new documentation. I've found several broken links across the new markdown files and a leftover TODO comment that should be addressed. Please see the detailed comments for specific locations and suggestions.
|
|
||
| ## dataset/ | ||
|
|
||
| Contains all evaluation data, configurations, and resources. See the [Configuration Overview](./config/about.md) for detailed file formats. |
There was a problem hiding this comment.
This link to [Configuration Overview](./config/about.md) appears to be broken as the target file docs/contributing/config/about.md does not exist. Consider linking to ../reference/configuration_reference.md instead.
| Contains all evaluation data, configurations, and resources. See the [Configuration Overview](./config/about.md) for detailed file formats. | |
| Contains all evaluation data, configurations, and resources. See the [Configuration Overview](../reference/configuration_reference.md) for detailed file formats. |
|
|
||
| ### devals_cli/ (devals) | ||
|
|
||
| Dart CLI for creating and managing evaluation tasks and jobs. See the [CLI documentation](./cli.md) for full command reference. |
There was a problem hiding this comment.
This link to [CLI documentation](./cli.md) is broken as the target file docs/contributing/cli.md does not exist. The correct path seems to be ../reference/cli.md.
| Dart CLI for creating and managing evaluation tasks and jobs. See the [CLI documentation](./cli.md) for full command reference. | |
| Dart CLI for creating and managing evaluation tasks and jobs. See the [CLI documentation](../reference/cli.md) for full command reference. |
| > with_context: | ||
| > context_files: [./context_files/dart_docs.md] | ||
| > ``` | ||
| > See [Configuration Overview](config/about.md#variants) for details. |
There was a problem hiding this comment.
The link to [Configuration Overview](config/about.md#variants) is broken. Please update it to point to the correct documentation.
| > See [Configuration Overview](config/about.md#variants) for details. | |
| > See [Configuration Overview](../reference/configuration_reference.md#variants) for details. |
| Now that you've run your first custom evaluation, here are some things to try: | ||
|
|
||
| - **Add more samples** to your task: `devals create sample` | ||
| - **Try different task types** — `question_answer`, `bug_fix`, or `flutter_code_gen`. See [all available task functions](../packages/dash_evals.md). |
There was a problem hiding this comment.
The link to [all available task functions](../packages/dash_evals.md) is broken. The correct path appears to be ../contributing/packages/dash_evals.md.
| - **Try different task types** — `question_answer`, `bug_fix`, or `flutter_code_gen`. See [all available task functions](../packages/dash_evals.md). | |
| - **Try different task types** — `question_answer`, `bug_fix`, or `flutter_code_gen`. See [all available task functions](../contributing/packages/dash_evals.md). |
|
|
||
| --- | ||
|
|
||
| See the [Configuration Overview](./config/about.md) for detailed configuration file documentation. |
There was a problem hiding this comment.
This link to [Configuration Overview](./config/about.md) is broken as the target file docs/reference/config/about.md does not exist. You might want to link to configuration_reference.md instead.
| See the [Configuration Overview](./config/about.md) for detailed configuration file documentation. | |
| See the [Configuration Reference](./configuration_reference.md) for detailed configuration file documentation. |
1 participant
Adds the docs site and updates relevant to the docs site