Conversation
There was a problem hiding this comment.
Pull request overview
Adds a new “Getting Started” documentation section to the Docusaurus website and updates the site configuration/styling to support Mermaid diagrams and customized Prism highlighting.
Changes:
- Add new Getting Started docs (prerequisites + quickstart) and a supported-devices reference page.
- Enable Mermaid support and configure Prism themes/additional languages in Docusaurus.
- Adjust docs sidebar category metadata and add CSS for code line numbering / Mermaid centering.
Reviewed changes
Copilot reviewed 11 out of 12 changed files in this pull request and generated 7 comments.
Show a summary per file
| File | Description |
|---|---|
| website/package.json | Adds Mermaid theme + Prism renderer dependencies needed by the updated Docusaurus config. |
| website/package-lock.json | Locks transitive dependencies introduced by Mermaid/Prism additions. |
| website/docusaurus.config.ts | Enables Mermaid and configures Prism themes/additional languages. |
| website/docs/reference/supported-devices.mdx | New reference doc describing accelerator label conventions and kubectl usage. |
| website/docs/reference/odin/category.yaml | Updates sidebar ordering and ensures the category is expanded by default. |
| website/docs/reference/heimdall/category.yaml | Ensures the category is expanded by default. |
| website/docs/reference/category.yaml | Ensures the Reference category is expanded by default. |
| website/docs/getting-started/category.yaml | Introduces the Getting Started sidebar category. |
| website/docs/getting-started/prerequisites.md | New prerequisites guide (cluster requirements + required components). |
| website/docs/getting-started/quickstart.md | New end-to-end quickstart walkthrough including a Mermaid architecture diagram. |
| website/css/custom.css | Adds code line-number styling, highlighted-line colors, and Mermaid centering tweaks. |
| website/AGENTS.md | Updates contributor/agent docs rules for _category_.yaml metadata. |
Files not reviewed (1)
- website/package-lock.json: Language not supported
| "@cmfcmf/docusaurus-search-local": "^2.0.1", | ||
| "@docusaurus/core": "3.9.2", | ||
| "@docusaurus/preset-classic": "3.9.2", | ||
| "@docusaurus/theme-mermaid": "^3.9.2", |
There was a problem hiding this comment.
@docusaurus/core and @docusaurus/preset-classic are pinned to 3.9.2, but @docusaurus/theme-mermaid is declared with a caret range. This can pull a different Docusaurus minor/patch than the rest of the stack and cause subtle build/runtime incompatibilities. Consider pinning @docusaurus/theme-mermaid to the same exact version as the other Docusaurus packages (and keep them in lockstep when upgrading).
| "@docusaurus/theme-mermaid": "^3.9.2", | |
| "@docusaurus/theme-mermaid": "3.9.2", |
| markdown: { | ||
| mermaid: true, | ||
| hooks: { | ||
| onBrokenMarkdownLinks: 'warn', | ||
| }, | ||
| }, |
There was a problem hiding this comment.
onBrokenMarkdownLinks is a top-level Docusaurus config option (sibling to onBrokenLinks). Nesting it under markdown.hooks is unlikely to be recognized by Docusaurus and may be silently ignored. Move onBrokenMarkdownLinks: 'warn' to the top level (and remove the unknown hooks block) so broken MD links are handled as intended.
|
|
||
| The MoAI Inference Framework provides features to efficiently utilize clusters with heterogeneous accelerators. | ||
|
|
||
| Each accelerator is identified by labels prefixed with `moai.moreh.io`. Users can specificy the accelerator on which a model should run, or allow the framework to automatically select the optimal accelerator. Below is the list of accelerator labels supported by the MoAI Inference Framework. |
There was a problem hiding this comment.
Typo: "specificy" should be "specify".
| Each accelerator is identified by labels prefixed with `moai.moreh.io`. Users can specificy the accelerator on which a model should run, or allow the framework to automatically select the optimal accelerator. Below is the list of accelerator labels supported by the MoAI Inference Framework. | |
| Each accelerator is identified by labels prefixed with `moai.moreh.io`. Users can specify the accelerator on which a model should run, or allow the framework to automatically select the optimal accelerator. Below is the list of accelerator labels supported by the MoAI Inference Framework. |
| @@ -0,0 +1,65 @@ | |||
| --- | |||
| title: 'Supported devices' | |||
There was a problem hiding this comment.
This doc is a .mdx file but its frontmatter is missing sidebar_label, which is required by website/AGENTS.md and is consistently present in existing reference MDX docs. Add sidebar_label (and keep the title in single quotes) to match the repo’s documentation conventions.
| title: 'Supported devices' | |
| title: 'Supported devices' | |
| sidebar_label: 'Supported devices' |
| * **moai-inference-framework** v0.2.0 | ||
| * **moai-inference-preset** v0.2.0 |
There was a problem hiding this comment.
The component versions listed here (v0.2.0) don’t match the versions referenced in getting-started/prerequisites.md (v0.3.0 for both charts). Align these so the quickstart prerequisites are consistent and users install the intended versions.
| * **moai-inference-framework** v0.2.0 | |
| * **moai-inference-preset** v0.2.0 | |
| * **moai-inference-framework** v0.3.0 | |
| * **moai-inference-preset** v0.3.0 |
| referencegrants.gateway.networking.k8s.io 2025-12-12T02:03:07Z | ||
| ``` | ||
|
|
||
| You can use any gateway controller compatible with the Gateway API Inference Extension. using either **Istio** or **Kgateway** is recommended, and installation instructions for both are provided below. |
There was a problem hiding this comment.
Sentence capitalization/grammar: "...Inference Extension. using either..." should start a new sentence (or use a comma) and capitalize "Using".
| You can use any gateway controller compatible with the Gateway API Inference Extension. using either **Istio** or **Kgateway** is recommended, and installation instructions for both are provided below. | |
| You can use any gateway controller compatible with the Gateway API Inference Extension, using either **Istio** or **Kgateway** is recommended, and installation instructions for both are provided below. |
1 participant
No description provided.