Skip to content

feat(ml-cellar): add docs command#17

Merged
scepter914 merged 14 commits intomainfrom
feat/docs_command
Jan 17, 2026
Merged

feat(ml-cellar): add docs command#17
scepter914 merged 14 commits intomainfrom
feat/docs_command

Conversation

@scepter914
Copy link
Copy Markdown
Owner

Summary

feat(ml-cellar): add docs command

Change point

  • feat(ml-cellar): add docs command

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>
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

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

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 docs command with template rendering functionality using regex-based placeholder substitution
  • Removed unused write_result_to_readme function 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.

Comment thread docs/docs_template.md Outdated
scepter914 and others added 2 commits January 17, 2026 22:21
Signed-off-by: scepter914 <scepter914@gmail.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
@scepter914 scepter914 merged commit 7dcb7c8 into main Jan 17, 2026
1 check passed
@scepter914 scepter914 deleted the feat/docs_command branch January 17, 2026 23:00
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