feat(ml-cellar): add docs command#17
Merged
scepter914 merged 14 commits intomainfrom Jan 17, 2026
Merged
Conversation
Signed-off-by: scepter914 <scepter914@gmail.com>
Signed-off-by: scepter914 <scepter914@gmail.com>
Signed-off-by: scepter914 <scepter914@gmail.com>
Signed-off-by: scepter914 <scepter914@gmail.com>
Signed-off-by: scepter914 <scepter914@gmail.com>
Signed-off-by: scepter914 <scepter914@gmail.com>
Signed-off-by: scepter914 <scepter914@gmail.com>
Signed-off-by: scepter914 <scepter914@gmail.com>
Signed-off-by: scepter914 <scepter914@gmail.com>
Signed-off-by: scepter914 <scepter914@gmail.com>
Signed-off-by: scepter914 <scepter914@gmail.com>
Signed-off-by: scepter914 <scepter914@gmail.com>
There was a problem hiding this comment.
Pull request overview
This PR adds a new docs command to ml-cellar that generates documentation for ML models by rendering markdown templates with JSON data. The command reads a template file and a results JSON file, then replaces placeholders in the template with corresponding values from the JSON.
Changes:
- Added new
docscommand with template rendering functionality using regex-based placeholder substitution - Removed unused
write_result_to_readmefunction from check command - Enhanced documentation with comprehensive usage examples and configuration details
Reviewed changes
Copilot reviewed 23 out of 33 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| src/bin/ml-cellar/docs.rs | New module implementing documentation generation with JSON-to-markdown template rendering |
| src/bin/ml-cellar/main.rs | Registered new Docs command with CLI argument parsing |
| src/bin/ml-cellar/check.rs | Removed obsolete write_result_to_readme function |
| src/rack.rs | Added detailed documentation for DocumentConfig fields |
| tests/test_docs.rs | Comprehensive test suite covering success and failure scenarios |
| tests/fixtures/* | Added test fixtures for docs command validation |
| docs/docs_template.md | Updated documentation with detailed usage guide |
| README.md | Minor improvements to repository setup instructions |
| Cargo.toml | Added serde_json and regex dependencies |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Signed-off-by: scepter914 <scepter914@gmail.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
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
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.
Summary
feat(ml-cellar): add docs command
Change point