shancheas
2445df8e20
- Revised the `doc-updater` documentation to clarify the separation between user and technical documentation, specifying locations and audiences for each type. - Introduced new rules for authoring user documentation in VitePress, emphasizing the exclusion of technical content and the use of PlantUML for diagrams. - Added a new `documentation.mdc` file to outline the documentation split and rules for maintaining clarity and consistency across the codebase. - Updated existing documentation to reflect the new guidelines, ensuring a streamlined approach to documentation management. These changes enhance the clarity and organization of documentation efforts, improving the overall user experience and maintainability of the codebase.
Frontend Monorepo Template
A scalable, enterprise-ready Web & Desktop monorepo built with Turborepo, pnpm, Vite, and Electron. This repository is designed for long-term maintainability, featuring shared logic and UI libraries, centralized tooling configuration, turbo-powered task orchestration, and native desktop distribution with auto-updates.
🌍 Global Context
This repository utilizes a monorepo architecture to seamlessly share core systems, business logic, and UI components across multiple distribution targets (Web, Desktop, and Landing Page).
Topology Overview
apps/: Deployable applications (web,desktop,landing,docs-dev).packages/: Shared libraries and core engines (core-api,core-storage,ui,utils,configs, etc.).
📚 Single Source of Truth
Important
Internal Documentation Hub All documentation, installation guides, architectural deep-dives, and API references are hosted internally via our VitePress application.
-
View in Git Repository (Raw Markdown): Read Overview Documentation
-
Run Documentation Locally:
If this is your first time running the documentation, ensure you install the dependencies first:
pnpm installThen, start the documentation server:
pnpm dev:docs-dev
📝 License
This project is private and proprietary.