Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR adds comprehensive documentation for features and operations of the MoAI Inference Framework. The changes improve the website structure by introducing two new major documentation sections: "Features" and "Operations", while also updating existing documentation to follow consistent formatting guidelines.
Changes:
- Added "Features" section documenting presets functionality for simplified InferenceService deployment
- Added "Operations" section with guides for Hugging Face model management using persistent volumes and container image caching with Harbor
- Updated documentation formatting across multiple files to follow AGENTS.md guidelines (quote consistency, heading capitalization, frontmatter structure)
Reviewed changes
Copilot reviewed 13 out of 17 changed files in this pull request and generated 9 comments.
Show a summary per file
| File | Description |
|---|---|
| website/docs/features/category.yaml | Adds category configuration for new Features section |
| website/docs/features/preset.mdx | New comprehensive guide on using and customizing InferenceServiceTemplate presets |
| website/docs/operations/category.yaml | Adds category configuration for new Operations section |
| website/docs/operations/hf-model-management-with-pv.mdx | New guide for managing Hugging Face models with persistent volumes |
| website/docs/operations/container-image-caching-with-harbor/index.mdx | New guide for setting up Harbor as a local container registry cache |
| website/docs/reference/supported-devices.mdx | Minor formatting and content improvements to accelerator labels documentation |
| website/docs/reference/odin/api-reference.mdx | Adds sidebar_position to frontmatter |
| website/docs/reference/heimdall/api-reference.mdx | Adds visual separator between API version sections |
| website/docs/reference/heimdall/plugins.mdx | Updates heading capitalization and adds section separators |
| website/docs/getting-started/quickstart.mdx | Updates import quotes, fixes internal link, and minor formatting |
| website/docs/getting-started/prerequisites.mdx | Updates import quotes, fixes external link, and YAML quote consistency |
| website/AGENTS.md | Clarifies frontmatter guidelines and adds image organization rules |
| AGENTS.md | Adds 'website' as a valid commit type scope |
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.
No description provided.