Skip to content

[Docs] Add a recipes page consolidating all E2E recipes#679

Merged
SumanthRH merged 8 commits intoNovaSky-AI:mainfrom
SumanthRH:recipe-docs
Nov 18, 2025
Merged

[Docs] Add a recipes page consolidating all E2E recipes#679
SumanthRH merged 8 commits intoNovaSky-AI:mainfrom
SumanthRH:recipe-docs

Conversation

@SumanthRH
Copy link
Member

@SumanthRH SumanthRH commented Nov 17, 2025

Adds a new overview page in the Recipes page consolidating all E2E recipes in SkyRL.

image

The table formats are a bit inconsistent, but that is fine IMO

x
Signed-off-by: SumanthRH <sumanthrh99@gmail.com>
x
Signed-off-by: SumanthRH <sumanthrh99@gmail.com>
x
Signed-off-by: SumanthRH <sumanthrh99@gmail.com>
x
Signed-off-by: SumanthRH <sumanthrh99@gmail.com>
x
Signed-off-by: SumanthRH <sumanthrh99@gmail.com>
x
Signed-off-by: SumanthRH <sumanthrh99@gmail.com>
Signed-off-by: SumanthRH <sumanthrh99@gmail.com>
@SumanthRH SumanthRH marked this pull request as ready for review November 17, 2025 21:41
@SumanthRH
Copy link
Member Author

/gemini review

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 introduces a new documentation page to consolidate end-to-end recipes, which is a great addition for users. The implementation is mostly good, but I've identified a couple of areas for improvement in the new overview.rst file. My main feedback is around improving the consistency and maintainability of the HTML tables by consolidating CSS styles. I've also noted a potential issue with duplicated WandB links that might need correction. Overall, these are good changes that improve the documentation.

Comment on lines +21 to +36
<style>
table.skytable {
border-collapse: collapse;
margin-bottom: 20px;
}
table.skytable th, table.skytable td {
border: 1px solid #ccc;
padding: 6px 10px;
}
table.skytable th {
background: #f2f2f2;
}
table.skytable tr:nth-child(even) {
background: #fafafa;
}
</style>
Copy link
Contributor

Choose a reason for hiding this comment

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

medium

To improve maintainability and visual consistency across the document, I suggest consolidating the styling for all tables. Currently, there are three different styling approaches used: the skytable class, the skytable2 class, and inline styles for the eval-table. This leads to an inconsistent look and makes future updates cumbersome.

You could define a single, unified style in one <style> block at the top of the file and apply it to all tables. Here's an example:

.. raw:: html

   <style>
     .recipe-table {
       border-collapse: collapse;
       margin-bottom: 20px;
       width: 100%;
     }
     .recipe-table th, .recipe-table td {
       border: 1px solid #ccc;
       padding: 8px;
       text-align: left;
     }
     .recipe-table th {
       background-color: #f2f2f2;
     }
     .recipe-table tr:nth-child(even) {
       background-color: #fafafa;
     }
     .recipe-table .highlight-row {
        background-color: #f2f2f2; 
        font-weight: bold;
     }
   </style>

You could then:

  1. Apply class="recipe-table" to all three <table> elements.
  2. Remove the second <style> block (for skytable2).
  3. Remove all inline style="..." attributes from the third table and its elements. The highlight-row class can be used for the "Average" row.
  4. Remove the <div style="width: 80%;"> wrapper.

This would make the tables look uniform and simplify the markup significantly.

Comment on lines +51 to +59
<tr>
<td>DAPO (w/o Dynamic Sampling)</td>
<td>Qwen/Qwen-2.5-7B-Math</td>
<td>0.633</td>
<td>-0.304</td>
<td>8xH100</td>
<td>320</td>
<td><a href="https://api.wandb.ai/links/sky-posttraining-uc-berkeley/ijmo1v6q">Link</a></td>
</tr>
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 WandB link is the same for all three entries in the DAPO recipes table. Since each row represents a different model and experiment, it's likely they should have unique links. Could you please verify that these links are correct? If they are different runs, pointing to the specific run would be more helpful for readers.

x
Signed-off-by: SumanthRH <sumanthrh99@gmail.com>
Copy link
Collaborator

@CharlieFRuan CharlieFRuan left a comment

Choose a reason for hiding this comment

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

Thank you!

@SumanthRH SumanthRH merged commit fa7209d into NovaSky-AI:main Nov 18, 2025
3 checks passed
li-boxuan pushed a commit to li-boxuan/SkyRL that referenced this pull request Nov 23, 2025
Adds a new overview page in the Recipes page consolidating all E2E
recipes in SkyRL.



<img width="1384" height="3160" alt="image"
src="https://github.com/user-attachments/assets/55bba9ff-af63-49ca-8342-81043d1b1499"
/>

The table formats are a bit inconsistent, but that is fine IMO

---------

Signed-off-by: SumanthRH <sumanthrh99@gmail.com>
dzorlu pushed a commit to fleet-ai/SkyRL that referenced this pull request Feb 4, 2026
Adds a new overview page in the Recipes page consolidating all E2E
recipes in SkyRL.



<img width="1384" height="3160" alt="image"
src="https://github.com/user-attachments/assets/55bba9ff-af63-49ca-8342-81043d1b1499"
/>

The table formats are a bit inconsistent, but that is fine IMO

---------

Signed-off-by: SumanthRH <sumanthrh99@gmail.com>
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