-
-
Notifications
You must be signed in to change notification settings - Fork 2
docs: enhance learning path and add custom validation recipe #135
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Closed
Tuntii
wants to merge
1
commit into
main
from
docs/learning-path-and-validation-11704321007872420411
Closed
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,5 +1,5 @@ | ||
| { | ||
| "last_processed_ref": "v0.1.335", | ||
| "date": "2026-02-23", | ||
| "notes": "Fixed MockServer examples in testing recipe. Added Graceful Shutdown recipe. Enhanced Learning Path with 'The Email Worker' mini-project." | ||
| "date": "2026-02-24", | ||
| "notes": "Enhanced Learning Path with tasks and knowledge checks. Added Custom Validation recipe. Added unlisted recipes to Summary." | ||
| } |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,41 @@ | ||
| # Run Report: 2026-02-24 | ||
|
|
||
| ## Version Detection | ||
| - **Version**: `v0.1.335` | ||
| - **Changes since last run**: None (Continuous Improvement run). | ||
|
|
||
| ## Documentation Updates | ||
|
|
||
| ### 1. Learning Path Improvements | ||
| - **File**: `docs/cookbook/src/learning/curriculum.md` | ||
| - **Changes**: | ||
| - Added explicit numbered tasks to all modules. | ||
| - Expanded "Knowledge Check" sections with more questions. | ||
| - Improved descriptions for Mini Projects. | ||
| - Added references to new recipes. | ||
|
|
||
| ### 2. New Cookbook Recipe | ||
| - **File**: `docs/cookbook/src/recipes/custom_validation.md` | ||
| - **Content**: | ||
| - Synchronous custom validators (`#[validate(custom = "...")]`). | ||
| - Asynchronous custom validators (`#[validate(custom_async = "...")]`). | ||
| - Using `ValidationContext` for dependency injection. | ||
| - Full runnable example. | ||
|
|
||
| ### 3. Cookbook Structure | ||
| - **File**: `docs/cookbook/src/SUMMARY.md` | ||
| - **Changes**: | ||
| - Added `Custom Validation` to recipes. | ||
| - Added `CI Simulation` and `Maintenance & Quality` to recipes (previously unlisted). | ||
| - **File**: `docs/cookbook/src/recipes/README.md` | ||
| - **Changes**: | ||
| - Synced with `SUMMARY.md`. | ||
|
|
||
| ## Coverage Status | ||
| - **Validation**: Coverage improved with dedicated custom validation guide. | ||
| - **Learning**: Curriculum is now more actionable and interactive. | ||
| - **Recipes**: Unlisted recipes are now discoverable. | ||
|
|
||
| ## Next Steps | ||
| - Review `rustapi-grpc` documentation for completeness. | ||
| - Consider adding a recipe for "Advanced Error Handling". |
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
Oops, something went wrong.
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The coverage map entry for Custom Validation incorrectly references
rustapi-validate/src/custom.rsas the source. While this file exists, it provides a programmatic Validator builder API that is not integrated with the#[derive(Validate)]macro. The actual source for custom validation iscustom_asyncsupport inrustapi-macros/src/lib.rs(lines 1426-1460) which only supports async custom validators. Since the recipe incorrectly documents synchronous custom validators that don't exist, this coverage entry is misleading.