Skip to content

Conversation

LucHeart
Copy link
Member

Summary

  • replace MkDocs setup with VitePress
  • use Node-based Docker build and update CI/dependabot
  • document VitePress dev workflow

Testing

  • CI=1 npm run docs:build

https://chatgpt.com/codex/tasks/task_e_68aa26ed0d3083279576e73ba048643b

@Copilot Copilot AI review requested due to automatic review settings August 23, 2025 20:59
Copy link

changeset-bot bot commented Aug 23, 2025

⚠️ No Changeset found

Latest commit: b6687b9

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

Copy link

@Copilot Copilot AI left a 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.

Comment on lines +3 to +5
export default defineConfig({
title: 'OpenShock Wiki',
description: 'Documentation for OpenShock',
Copy link
Preview

Copilot AI Aug 23, 2025

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.

Suggested change
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.

Copy link

cloudflare-workers-and-pages bot commented Aug 23, 2025

Deploying openshock-wiki with  Cloudflare Pages  Cloudflare Pages

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

View logs

@LucHeart LucHeart changed the base branch from master to develop August 24, 2025 21:09
@LucHeart LucHeart merged commit 71d2744 into develop Aug 24, 2025
4 checks passed
@LucHeart LucHeart deleted the codex/change-documentation-to-use-vitepress branch August 24, 2025 21:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant