chore: Moving sample models into docs folder#118
Conversation
WalkthroughDocumentation reorganization: moved the sample models README from Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Poem
Pre-merge checks and finishing touches✅ Passed checks (3 passed)
✨ Finishing touches🧪 Generate unit tests
📜 Recent review detailsConfiguration used: CodeRabbit UI Review profile: CHILL Plan: Pro 📒 Files selected for processing (2)
🚧 Files skipped from review as they are similar to previous changes (2)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
There was a problem hiding this comment.
Actionable comments posted: 1
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (5)
README.md(1 hunks)demo-models/README.md(1 hunks)deployment/samples/models/README.md(0 hunks)deployment/samples/models/rbac/all-tiers.yaml(0 hunks)deployment/samples/models/rbac/kustomization.yaml(0 hunks)
💤 Files with no reviewable changes (3)
- deployment/samples/models/rbac/all-tiers.yaml
- deployment/samples/models/rbac/kustomization.yaml
- deployment/samples/models/README.md
🔇 Additional comments (1)
demo-models/README.md (1)
1-11: Docs match the relocated demos.The instructions align with the new root-level directory and give clear deploy steps.
README.md
Outdated
| - Open an issue on GitHub | ||
| - Check the [deployment guide](deployment/README.md) for troubleshooting | ||
| - Review the [samples](deployment/samples/models/) for examples | ||
| - Review the [samples](samples/models/) for examples |
There was a problem hiding this comment.
Broken link after directory move.
The new path samples/models/ doesn’t exist after relocating the demo assets; the directory is now demo-models/, so this link 404s. Please update the href (and link text if desired) to point at the new location.
-- Review the [samples](samples/models/) for examples
+- Review the [demo models](demo-models/) for examples📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| - Review the [samples](samples/models/) for examples | |
| Review the [demo models](demo-models/) for examples |
🤖 Prompt for AI Agents
In README.md around line 211, the link points to the removed path
samples/models/ causing a 404; update the href to demo-models/ (and optionally
change link text to "demo-models") so the link points to the relocated
directory, ensuring any relative path context is preserved.
There was a problem hiding this comment.
I wonder if putting those models under top-level docs/samples/models wouldn't help in organizing user-facing content and examples?
I also think that without rbac/ piece, which this PR removes, we can't use AuthPolicy (and subsequent (token)rate limiting) for these models, they're accessible for everyone.
bartoszmajsak
left a comment
There was a problem hiding this comment.
Couple of nits in the docs - namely, relative paths alignment
Co-authored-by: Bartosz Majsak <bartosz.majsak@gmail.com>
Co-authored-by: Bartosz Majsak <bartosz.majsak@gmail.com>
dmytro-zaharnytskyi
left a comment
There was a problem hiding this comment.
Don't like idea putting models under docs/ dir, (seems confusing) but anyway, all changes lead to the greater good :))
* Moving demo models to the root directory * Adding back in rbac * Moving to docs/samples/models * Update docs/samples/models/README.md Co-authored-by: Bartosz Majsak <bartosz.majsak@gmail.com> * Update docs/samples/models/README.md Co-authored-by: Bartosz Majsak <bartosz.majsak@gmail.com> * Addressing comment --------- Co-authored-by: Jamie Land <hokie10@gmail.com> Co-authored-by: Bartosz Majsak <bartosz.majsak@gmail.com>
Moved the sample models to the root directory. And simplified the readme
Summary by CodeRabbit
Documentation
Bug Fixes