From 81a62402ef6f8900ff092366121a9b7a4263ba52 Mon Sep 17 00:00:00 2001 From: Natsuu Date: Fri, 27 Feb 2026 17:18:25 +0800 Subject: Restructure docs into manual/development and add implementation docs (#94) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit ## Summary by Sourcery Restructure documentation into separate manual and development sections, introduce detailed internal implementation docs for auth/Java/mod loaders, and update site navigation, landing page links, and MDX tooling (Mermaid, card styling) to match the new structure and tech stack. Enhancements: - Enable Mermaid rendering support in the docs app and add a reusable Mermaid React component. - Refine Docs page rendering by customizing Card styling and removing redundant in-page titles/descriptions rendered by the layout. - Align docs source configuration and routing comments with the new manual-based default paths. Documentation: - Split user-facing docs under a new manual section and move contributor content into a dedicated development section for both English and Chinese. - Add comprehensive internal implementation documentation covering authentication, Java management, mod loader/version merging, event bus, and architecture patterns in both English and Chinese. - Update existing feature docs (mod loaders, Java, authentication) and getting-started/troubleshooting pages to be more conceptual, pointing to implementation docs for technical details. - Refresh architecture docs to reflect the React/Zustand frontend stack and add Mermaid-based architecture diagrams. - Adjust navigation labels, home-page CTAs, and doc links to target the new manual/development structure and routes. --------- Co-authored-by: 简律纯 --- packages/docs/package.json | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) (limited to 'packages/docs/package.json') diff --git a/packages/docs/package.json b/packages/docs/package.json index 18a5bf3..4ee4baf 100644 --- a/packages/docs/package.json +++ b/packages/docs/package.json @@ -18,11 +18,13 @@ "fumadocs-mdx": "14.2.6", "fumadocs-ui": "16.4.7", "isbot": "^5.1.32", + "mermaid": "^11.12.3", "react": "^19.2.3", "react-dom": "^19.2.3", "react-router": "^7.12.0" }, "devDependencies": { + "@biomejs/biome": "^2.3.11", "@react-router/dev": "^7.12.0", "@tailwindcss/vite": "^4.1.18", "@types/mdx": "^2.0.13", @@ -33,7 +35,6 @@ "tailwindcss": "^4.1.18", "typescript": "^5.9.3", "vite": "^7.3.1", - "vite-tsconfig-paths": "^6.0.4", - "@biomejs/biome": "^2.3.11" + "vite-tsconfig-paths": "^6.0.4" } } -- cgit v1.2.3-70-g09d2