MAF-19263: feat(website): add Docusaurus documentation setup and workflows #54
Conversation
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
- Introduced a Docusaurus-based documentation site for the MoAI Inference Framework. - Added GitHub Actions workflows for previewing and releasing documentation. - Configured essential files including `docusaurus.config.ts`, `package.json`, and sidebars. - Created initial documentation content in `home.md` and `overview.md`, along with prerequisites and getting started guides. - Established a README for local development and production build instructions.
…figuration files - Introduced a .gitignore file to exclude unnecessary files from version control. - Added a .prettierrc file for consistent code formatting. - Created AGENTS.md to define contribution rules and documentation standards for the website. - Updated docusaurus.config.ts to refine static directories and improve link handling. - Established a custom CSS file for styling the documentation site. - Added initial content for benchmarking and best practices documentation, including categories and articles. - Configured package.json and package-lock.json to include necessary dependencies for Docusaurus.
…ration - Updated GitHub Actions workflows to include environment variables for documentation site URLs and versioning. - Modified docusaurus.config.ts to dynamically set site and base URLs, and added support for version dropdown in the documentation. - Adjusted CSS to improve the visibility of documentation elements across versions.
…andardize quotes and improve readability - Updated quotes in `docs-preview.yaml` and `docs-release.yaml` from single to double quotes for consistency. - Ensured environment variable values are uniformly formatted across both workflow files.
…N and specific repository for documentation publishing - Changed the environment variable from GITHUB_TOKEN to GITOPS_TOKEN in both `docs-preview.yaml` and `docs-release.yaml`. - Updated the REPO variable to point to "moreh-dev/test-docs.moreh.io" for consistency in documentation publishing.
…t practices - Introduced versioning support with a new versions.json file. - Added initial documentation for version v0.0.0, including home, benchmarking, and best practices sections. - Created structured categories for benchmarking and best practices, enhancing navigation and organization. - Implemented articles on resource allocation, auto-scaling, expert parallelism, and load-aware routing to guide users in optimizing their inference setups.
- Introduced color mode settings in docusaurus.config.ts to support dark mode by default. - Enabled respect for user preferences regarding color scheme and provided an option to disable the switch.
Contributor
There was a problem hiding this comment.
Pull request overview
Adds a Docusaurus-based documentation site under website/ and introduces GitHub Actions workflows to build and publish preview/release documentation builds.
Changes:
- Adds Docusaurus configuration, TypeScript config, sidebar setup, styling, and package manifest for the docs site.
- Adds initial documentation content (including an initial versioned docs snapshot
v0.0.0) and static brand assets. - Adds CI workflows to build and publish docs previews on PRs/main and releases on version tags.
Reviewed changes
Copilot reviewed 61 out of 89 changed files in this pull request and generated 24 comments.
Show a summary per file
| File | Description |
|---|---|
website/versions.json |
Introduces Docusaurus versions registry (initial version). |
website/versioned_sidebars/version-v0.0.0-sidebars.json |
Adds autogenerated sidebar for versioned docs. |
website/versioned_docs/version-v0.0.0/static/moreh-logo.svg |
Adds versioned static logo asset. |
website/versioned_docs/version-v0.0.0/static/moreh-logo-white.svg |
Adds versioned static logo (dark-mode) asset. |
website/versioned_docs/version-v0.0.0/static/moreh-icon.png |
Adds versioned favicon/icon asset. |
website/versioned_docs/version-v0.0.0/reference/odin_inference_service.md |
Adds versioned reference doc for Odin. |
website/versioned_docs/version-v0.0.0/reference/heimdall_scheduler.md |
Adds versioned reference doc for Heimdall. |
website/versioned_docs/version-v0.0.0/reference/_category_.json |
Adds versioned “Reference” category metadata. |
website/versioned_docs/version-v0.0.0/home.md |
Adds versioned home page content. |
website/versioned_docs/version-v0.0.0/getting_started/supported_devices.md |
Adds versioned “Supported devices” doc. |
website/versioned_docs/version-v0.0.0/getting_started/prerequisites.md |
Adds versioned prerequisites doc. |
website/versioned_docs/version-v0.0.0/getting_started/overview.md |
Adds versioned getting started overview doc. |
website/versioned_docs/version-v0.0.0/getting_started/monitoring.md |
Adds versioned monitoring doc. |
website/versioned_docs/version-v0.0.0/getting_started/_category_.json |
Adds versioned “Getting Started” category metadata. |
website/versioned_docs/version-v0.0.0/features/preset.md |
Adds versioned presets feature doc. |
website/versioned_docs/version-v0.0.0/features/prefix_cache_aware_routing.md |
Adds versioned prefix-cache-aware routing doc. |
website/versioned_docs/version-v0.0.0/features/prefill_decode_disaggregation.md |
Adds versioned PD disaggregation feature doc. |
website/versioned_docs/version-v0.0.0/features/expert_parallelism.md |
Adds versioned expert parallelism feature doc. |
website/versioned_docs/version-v0.0.0/features/auto_scaling.md |
Adds versioned auto-scaling feature doc. |
website/versioned_docs/version-v0.0.0/features/_category_.json |
Adds versioned “Features” category metadata. |
website/versioned_docs/version-v0.0.0/best_practices/resource_allocation.md |
Adds versioned resource allocation best-practices doc. |
website/versioned_docs/version-v0.0.0/best_practices/hf_model_management_with_pv.md |
Adds versioned HF model management best-practices doc. |
website/versioned_docs/version-v0.0.0/best_practices/_category_.json |
Adds versioned “Best practices” category metadata. |
website/versioned_docs/version-v0.0.0/benchmarking/more_benchmarking_for_deepseek_r1_671b_on_amd_mi300x_gpus/_category_.json |
Adds versioned benchmarking subcategory metadata. |
website/versioned_docs/version-v0.0.0/benchmarking/_category_.json |
Adds versioned “Benchmarking” category metadata. |
website/tsconfig.json |
Adds TS config for Docusaurus TypeScript config files. |
website/static/moreh-logo.svg |
Adds site-level static logo asset. |
website/static/moreh-logo-white.svg |
Adds site-level dark-mode logo asset. |
website/static/moreh-icon.png |
Adds site-level icon asset. |
website/sidebars.ts |
Adds autogenerated sidebar definition. |
website/package.json |
Adds website dependencies and scripts for Docusaurus. |
website/docusaurus.config.ts |
Adds Docusaurus config (versions, navbar, local search, etc.). |
website/docs/static/moreh-logo.svg |
Adds docs-local static logo asset. |
website/docs/static/moreh-logo-white.svg |
Adds docs-local dark-mode logo asset. |
website/docs/static/moreh-icon.png |
Adds docs-local icon asset. |
website/docs/reference/odin_inference_service.md |
Adds current reference doc for Odin. |
website/docs/reference/heimdall_scheduler.md |
Adds current reference doc for Heimdall. |
website/docs/reference/_category_.json |
Adds current “Reference” category metadata. |
website/docs/home.md |
Adds current home page content. |
website/docs/getting_started/supported_devices.md |
Adds current “Supported devices” doc. |
website/docs/getting_started/quickstart.md |
Adds current quickstart guide. |
website/docs/getting_started/prerequisites.md |
Adds current prerequisites doc. |
website/docs/getting_started/overview.md |
Adds current getting started overview doc. |
website/docs/getting_started/monitoring.md |
Adds current monitoring doc. |
website/docs/getting_started/_category_.json |
Adds current “Getting Started” category metadata. |
website/docs/features/preset.md |
Adds current presets feature doc. |
website/docs/features/prefix_cache_aware_routing.md |
Adds current prefix-cache-aware routing doc. |
website/docs/features/prefill_decode_disaggregation.md |
Adds current PD disaggregation feature doc. |
website/docs/features/expert_parallelism.md |
Adds current expert parallelism feature doc. |
website/docs/features/auto_scaling.md |
Adds current auto-scaling feature doc. |
website/docs/features/_category_.json |
Adds current “Features” category metadata. |
website/docs/best_practices/resource_allocation.md |
Adds current resource allocation best-practices doc. |
website/docs/best_practices/hf_model_management_with_pv.md |
Adds current HF model management best-practices doc. |
website/docs/best_practices/_category_.json |
Adds current “Best practices” category metadata. |
website/docs/benchmarking/more_benchmarking_for_deepseek_r1_671b_on_amd_mi300x_gpus/_category_.json |
Adds current benchmarking subcategory metadata. |
website/docs/benchmarking/_category_.json |
Adds current “Benchmarking” category metadata. |
website/css/custom.css |
Adds branding/colors, navbar GitHub icon styling, and search theming. |
website/README.md |
Adds website dev/build/versioning instructions. |
website/AGENTS.md |
Adds contributor/automation rules for the website subproject. |
website/.prettierrc |
Adds formatting rules for website content/config. |
website/.gitignore |
Adds ignores for Node/Docusaurus build artifacts and tooling. |
.github/workflows/docs-release.yaml |
Adds tag-based docs build + publish workflow. |
.github/workflows/docs-preview.yaml |
Adds PR/main docs build + publish preview workflow. |
website/versioned_docs/version-v0.0.0/reference/odin_inference_service.md
Outdated
Show resolved
Hide resolved
website/versioned_docs/version-v0.0.0/features/prefix_cache_aware_routing.md
Show resolved
Hide resolved
…Actions - Changed cache-dependency-path in both docs-preview.yaml and docs-release.yaml from package.json to package-lock.json for improved dependency management. - Added a new guideline in AGENTS.md regarding the handling of generated documentation output to prevent manual edits. - Updated README.md and various documentation files to reflect the new versioning for moai-inference-framework and moai-inference-preset to v0.3.0. - Corrected minor typos and ensured consistency in documentation across multiple files.
hhk7734
requested changes
Feb 12, 2026
Member
hhk7734
left a comment
hhk7734
left a comment
There was a problem hiding this comment.
https://docusaurus.io/docs/deployment#environment-settings
package.json에 "deploy": "docusaurus deploy", 등록하고 deploy 명령어 쓰면 과정이 간단해질 것 같아요.
cd-docs-development.yaml
cd-docs-production.yaml
로 이름 변경해주세요
hhk7734
reviewed
Feb 12, 2026
…tion development and production - Introduced two new workflows: `cd-docs-development.yaml` for previewing documentation on main branch pushes and pull requests, and `cd-docs-production.yaml` for publishing documentation on version tag pushes. - Configured environment variables for branch management and documentation site URLs. - Implemented steps for checking out code, setting up Node.js, installing dependencies, building the Docusaurus site, and publishing to the specified branches in the repository.
…tep from production workflow - Eliminated the step for creating documentation version from the tag in `cd-docs-production.yaml` to streamline the workflow process.
…KEN for documentation publishing - Replaced GITHUB_TOKEN with MIF_DOCS_TOKEN in both `cd-docs-development.yaml` and `cd-docs-production.yaml` to ensure proper authentication for publishing documentation to the specified repository.
Contributor
Author
|
Member
생각해보니 cd-docs.yaml 하나만 남기면 되는거 아니에요? |
Contributor
Author
이 부분도 고민을 해 보았는데, docs.moreh.io 도메인에서도 Dev 내용을 확인할 수 있게 배포한다면 하나만 남겨도 되고, staging을 두어서 내부 자료로만 Dev를 보겠다고 하면 따로 둘 수도 있습니다. |
… single configuration - Removed the separate `cd-docs-development.yaml` and `cd-docs-production.yaml` workflows. - Introduced a new unified workflow `cd-docs.yaml` for building and deploying Docusaurus documentation to GitHub Pages. - Updated `docusaurus.config.ts` to utilize environment variables for organization and project names, enhancing configurability. - Added a deploy script to `package.json` for streamlined deployment processes.
…ion workflow - Changed the trigger for the documentation deployment workflow to activate on pushes to the main branch instead of version tags, ensuring more immediate updates to the documentation site.
…loyment workflow - Eliminated the build step from the `cd-docs.yaml` workflow to streamline the deployment process for GitHub Pages.
Contributor
Author
|
docs.moreh.io 도메인을 사용한다면 필요한 docusaurus.config.ts 수정이 있어서 확인좀 진행하겠습니다. |
Contributor
Author
|
@hhk7734 님, 지금 이 PR에 docs.moreh.io에 바로 배포(docs.moreh.io 프로젝트의 publish-build branch에 바로 push하도록 설정)하도록 설정한 commit을 추가할지, 별도의 PR로 진행할지만 결정하면 될것 같습니다. |
Member
|
test-docs.moreh.io 로 노출시킬거에요 |
hhk7734
reviewed
Feb 12, 2026
…on workflow - Changed the deployment branch from "publish-build" to "main" in the `cd-docs.yaml` workflow to align with the current branch management strategy.
hhk7734
reviewed
Feb 12, 2026
…ntation site - Replaced environment variables for organization and project names with hardcoded values for the documentation site URL and base URL. - Set the documentation site URL to 'https://test-docs.moreh.io/' and base URL to '/'.
… documentation - Added missing newline at the end of `.prettierrc` file. - Simplified the `include` array in `tsconfig.json` by removing unnecessary line breaks. - Corrected a typo in the participant name from "Scehduling profile 2" to "Scheduling profile 2" in both `heimdall_scheduler.mdx` and its versioned counterpart.
Contributor
Author
|
마지막으로 deploy test하기 위해 pull_request 조건 추가한 다음 삭제하겠습니다. |
…on deployment - Added a pull request trigger to the `cd-docs.yaml` workflow to ensure documentation updates are deployed on pull requests to the main branch.
hhk7734
requested changes
Feb 12, 2026
Member
hhk7734
left a comment
hhk7734
left a comment
There was a problem hiding this comment.
website/static/CNAME 파일 만들고 거기에 test-docs.moreh.io 텍스트 추가해주세요
- Created a new CNAME file to set the custom domain for the documentation site to 'test-docs.moreh.io'.
Contributor
Author
|
…tation deployment workflow - Removed the pull request trigger from the `cd-docs.yaml` workflow to simplify the deployment process, focusing on pushes to the main branch only.
hhk7734
approved these changes
Feb 12, 2026
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.