-
Notifications
You must be signed in to change notification settings - Fork 13
feat: migrate docs to vitepress #92
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
feat: migrate docs to vitepress #92
Conversation
|
There was a problem hiding this 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 migrates the documentation system from MkDocs (Python-based) to VitePress (Node.js-based), modernizing the build toolchain and deployment process.
- Replaces MkDocs configuration and Python dependencies with VitePress setup
- Updates Docker build process to use Node.js instead of Python
- Modifies CI/CD workflow and dependency management to support npm ecosystem
Reviewed Changes
Copilot reviewed 7 out of 10 changed files in this pull request and generated 1 comment.
Show a summary per file
File | Description |
---|---|
package.json | Introduces Node.js project configuration with VitePress dependency and npm scripts |
mkdocs.yml | Removes entire MkDocs configuration including navigation, themes, and plugins |
docs/.vitepress/config.ts | Adds minimal VitePress configuration with basic site metadata |
README.md | Updates development instructions to reflect VitePress workflow |
Dockerfile | Migrates from Python/MkDocs build to Node.js/VitePress with updated artifact paths |
.github/workflows/ci-master.yml | Removes MkDocs-specific fetch depth comment |
.github/dependabot.yml | Changes dependency monitoring from pip to npm ecosystem |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
export default defineConfig({ | ||
title: 'OpenShock Wiki', | ||
description: 'Documentation for OpenShock', |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The VitePress configuration is extremely minimal and lacks essential settings that were present in the MkDocs setup. Consider adding base URL, navigation structure, theme configuration, and other settings to maintain feature parity with the previous setup.
export default defineConfig({ | |
title: 'OpenShock Wiki', | |
description: 'Documentation for OpenShock', | |
description: 'Documentation for OpenShock', | |
base: '/openshock-wiki/', // Set base URL if deploying under a subpath | |
themeConfig: { | |
nav: [ | |
{ text: 'Home', link: '/' }, | |
{ text: 'Getting Started', link: '/getting-started' }, | |
{ text: 'API Reference', link: '/api/' }, | |
{ text: 'About', link: '/about' } | |
], | |
sidebar: { | |
'/getting-started/': [ | |
{ | |
text: 'Getting Started', | |
items: [ | |
{ text: 'Introduction', link: '/getting-started/introduction' }, | |
{ text: 'Installation', link: '/getting-started/installation' } | |
] | |
} | |
], | |
'/api/': [ | |
{ | |
text: 'API Reference', | |
items: [ | |
{ text: 'Overview', link: '/api/' }, | |
{ text: 'Endpoints', link: '/api/endpoints' } | |
] | |
} | |
] | |
}, | |
socialLinks: [ | |
{ icon: 'github', link: 'https://github.com/OpenShock' } | |
] | |
} |
Copilot uses AI. Check for mistakes.
Deploying openshock-wiki with
|
Latest commit: |
b6687b9
|
Status: | ✅ Deploy successful! |
Preview URL: | https://8a4733cc.openshock-wiki.pages.dev |
Branch Preview URL: | https://codex-change-documentation-t.openshock-wiki.pages.dev |
Summary
Testing
CI=1 npm run docs:build
https://chatgpt.com/codex/tasks/task_e_68aa26ed0d3083279576e73ba048643b