Create a proper documentation website for PyOps using VitePress, hosted on GitHub Pages and run through the existing Vite+ toolchain.
Goals
- Make end-user installation, first-run, planning, in-game integration, assistant, backup, and troubleshooting guidance easy to navigate and search.
- Move the existing technical material under a clearly separated Development section and rewrite it for web consumption.
- Keep documentation source in the main repository so app changes and docs can be reviewed together.
- Preserve the current app package and release workflow rather than coupling VitePress dependencies to the desktop application.
Proposed structure
- Use
docs/ as the VitePress site root.
- Put user-facing guides at the top level (
getting-started/, guide/, in-game/, troubleshooting/, reference/).
- Move and curate the current technical documents under
docs/development/.
- Run the docs as a separate Vite+ package with
vp install, vp check, and vp run docs:* commands.
- Build and deploy through a GitHub Pages Actions workflow.
Work
- Scaffold the Vite+ / VitePress documentation package and site theme.
- Define the information architecture and writing conventions.
- Write the first-run journey and core end-user guide from the actual application behavior.
- Split mixed user/developer topics such as bridge setup, configuration, desktop installation, and assistant use.
- Rewrite and reorganize the existing architecture and subsystem documentation.
- Add troubleshooting, reference, navigation, search, link validation, and Pages deployment.
- Update the root README and repository guide to point at and maintain the new site.
Done when
- The site builds cleanly through Vite+ and deploys on GitHub Pages.
- A new user can install PyOps, sync game data, create a first block, and understand the factory view using the published guide.
- Companion-mod, assistant, backup/restore, settings, and common failure paths are documented.
- Developer documentation remains available in a separate searchable section.
- Internal links and documented commands are verified.
Create a proper documentation website for PyOps using VitePress, hosted on GitHub Pages and run through the existing Vite+ toolchain.
Goals
Proposed structure
docs/as the VitePress site root.getting-started/,guide/,in-game/,troubleshooting/,reference/).docs/development/.vp install,vp check, andvp run docs:*commands.Work
Done when