Add Examples Catalog and Refine Contribution Guide #331
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Contributor
There was a problem hiding this comment.
Pull request overview
This PR adds a new Examples Catalog page to the documentation and significantly refines the Contributing Guide. The changes improve discoverability of examples and provide clearer guidance for contributors.
- Adds a new visual examples catalog page with card-based layout
- Refactors the contributing guide with structured sections and clearer expectations
- Updates CI maintenance status for azure and tinker examples from "Unmaintained" to active CI badges
Reviewed changes
Copilot reviewed 6 out of 6 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
| mkdocs.yml | Adds markdown extensions for emoji and HTML support; registers new examples catalog page |
| examples/README.md | Updates azure and tinker examples from unmaintained status to active CI badges; fixes grammar in note |
| docs/stylesheets/extra.css | Adds CSS rules for grid card layout with equal-height cards and bottom-aligned footer links |
| docs/how-to/examples-catalog.md | New examples catalog page with emoji icons and card-based layout for all examples |
| docs/community/contributing.md | Major refactor organizing contribution types, adding clearer workflows, and documenting where different content should live |
| .github/workflows/badge-examples.yml | Adds tinker and azure workflow badge aggregation |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
examples/README.md
Outdated
| |---------|-------------|----------------| | ||
| | [apo](./apo) | Automatic Prompt Optimization tutorials covering built-in, custom, and debugging workflows. | [](https://github.com/microsoft/agent-lightning/actions/workflows/badge-apo.yml) | | ||
| | [azure](./azure) | Supervised fine-tuning with Azure OpenAI. | **Unmaintained** — last verified with Agent-lightning v0.2.1 | | ||
| | [azure](./azure) | Supervised fine-tuning with Azure OpenAI. |  | |
There was a problem hiding this comment.
The azure badge image is missing a clickable link wrapper. For consistency with other maintained examples (apo, calc_x, spider, unsloth), wrap the badge with a link: [](https://github.com/microsoft/agent-lightning/actions/workflows/badge-azure.yml)
Suggested change
| | [azure](./azure) | Supervised fine-tuning with Azure OpenAI. |  | | |
| | [azure](./azure) | Supervised fine-tuning with Azure OpenAI. | [](https://github.com/microsoft/agent-lightning/actions/workflows/badge-azure.yml) | |
examples/README.md
Outdated
| | [search_r1](./search_r1) | Framework-free Search-R1 reinforcement learning training workflow with a retrieval backend. | **Unmaintained** — last verified with Agent-lightning v0.1.2 | | ||
| | [spider](./spider) | Text-to-SQL reinforcement learning training on the Spider dataset using LangGraph. | [](https://github.com/microsoft/agent-lightning/actions/workflows/badge-spider.yml) | | ||
| | [tinker](./tinker) | Reinforcement learning with Tinker as the backend training service. | **Unmaintained** — last verified with Agent-lightning v0.2.2 | | ||
| | [tinker](./tinker) | Reinforcement learning with Tinker as the backend training service. |  | |
There was a problem hiding this comment.
The tinker badge image is missing a clickable link wrapper. For consistency with other maintained examples (apo, calc_x, spider, unsloth), wrap the badge with a link: [](https://github.com/microsoft/agent-lightning/actions/workflows/badge-tinker.yml)
Suggested change
| | [tinker](./tinker) | Reinforcement learning with Tinker as the backend training service. |  | | |
| | [tinker](./tinker) | Reinforcement learning with Tinker as the backend training service. | [](https://github.com/microsoft/agent-lightning/actions/workflows/badge-tinker.yml) | |
examples/README.md
Outdated
| | [tinker](./tinker) | Reinforcement learning with Tinker as the backend training service. |  | | ||
| | [unsloth](./unsloth) | Supervised fine-tuning example powered by Unsloth with 4-bit quantization and LoRA. | [](https://github.com/microsoft/agent-lightning/actions/workflows/badge-unsloth.yml) | | ||
|
|
||
| *NOTE: CI status avoid taking any workflow running with latest dependencies into account. That's why we reference the corresponding `badge-*` workflows instead. Each example's own README also displays its `examples-*` workflow status whenever the project is maintained by CI.* |
There was a problem hiding this comment.
Corrected grammar: 'avoid taking' should be 'avoids taking' to agree with the singular subject 'CI status'.
Suggested change
| *NOTE: CI status avoid taking any workflow running with latest dependencies into account. That's why we reference the corresponding `badge-*` workflows instead. Each example's own README also displays its `examples-*` workflow status whenever the project is maintained by CI.* | |
| *NOTE: CI status avoids taking any workflow running with latest dependencies into account. That's why we reference the corresponding `badge-*` workflows instead. Each example's own README also displays its `examples-*` workflow status whenever the project is maintained by CI.* |
docs/how-to/examples-catalog.md
Outdated
| @@ -0,0 +1,81 @@ | |||
| # Examples Catalog | |||
|
|
|||
| !!! tip "Wanted to Contribute?" | |||
There was a problem hiding this comment.
Corrected grammar: 'Wanted to Contribute?' should be 'Want to Contribute?' to use present tense for an invitation.
Suggested change
| !!! tip "Wanted to Contribute?" | |
| !!! tip "Want to Contribute?" |
totoluo
pushed a commit
to totoluo/agent-lightning
that referenced
this pull request
Dec 6, 2025
totoluo
pushed a commit
to totoluo/agent-lightning
that referenced
this pull request
Dec 6, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.