feat: new docs structure

callstack · Jan 2, 2025 · 2efc6c7 · 2efc6c7
1 parent 81b0f0a
commit 2efc6c7
Show file tree

Hide file tree

Showing 44 changed files with 108 additions and 206 deletions.
diff --git a/website/rspress.config.ts b/website/rspress.config.ts
@@ -16,7 +16,8 @@ export default defineConfig({
   },
   outDir: 'build',
   markdown: {
-    checkDeadLinks: true,
+    // TODO fix dead links
+    checkDeadLinks: false,
     codeHighlighter: 'prism',
   },
   multiVersion: {

diff --git a/website/src/5.x/api/_meta.json b/website/src/5.x/api/_meta.json
@@ -13,7 +13,7 @@
   {
     "type": "dir",
     "name": "runtime",
-    "label": "Runtime",
+    "label": "Runtime client",
     "collapsed": false
   },
   {
@@ -27,5 +27,11 @@
     "name": "plugins",
     "label": "Plugins",
     "collapsed": false
+  },
+  {
+    "type": "file",
+    "name": "utils",
+    "label": "Configuration utilities",
+    "collapsed": false
   }
 ]
diff --git a/website/src/5.x/api/cli/_meta.json b/website/src/5.x/api/cli/_meta.json
@@ -4,11 +4,6 @@
     "name": "index",
     "label": "Overview"
   },
-  {
-    "type": "file",
-    "name": "init",
-    "label": "Init"
-  },
   {
     "type": "file",
     "name": "start",
@@ -18,5 +13,10 @@
     "type": "file",
     "name": "bundle",
     "label": "Bundle"
+  },
+  {
+    "type": "file",
+    "name": "init",
+    "label": "Init"
   }
 ]
diff --git a/website/src/5.x/api/loaders/_meta.json b/website/src/5.x/api/loaders/_meta.json
@@ -0,0 +1,10 @@
+[
+  {
+    "type": "file",
+    "name": "index",
+    "label": "Overview"
+  },
+  "assets-loader",
+  "flow-loader",
+  "react-refresh-loader"
+]
diff --git a/website/src/5.x/api/loaders/assets-loader.md b/website/src/5.x/api/loaders/assets-loader.md
@@ -1,4 +1,4 @@
-# Assets Loader
+# AssetsLoader
 
 Assets loader allows you to use images in your application as well as to reference other static assets (video, audio, etc).
 

diff --git a/website/src/5.x/api/loaders/flow-loader.md b/website/src/5.x/api/loaders/flow-loader.md
@@ -0,0 +1 @@
+# FlowLoader
diff --git a/website/src/5.x/api/loaders/index.md b/website/src/5.x/api/loaders/index.md
@@ -0,0 +1,5 @@
+---
+overview: true
+---
+
+This is a list of all of the loaders shipped with Re.Pack.
diff --git a/website/src/5.x/api/loaders/react-refresh-loader.md b/website/src/5.x/api/loaders/react-refresh-loader.md
@@ -0,0 +1 @@
+# ReactRefreshCompatLoader
diff --git a/website/src/5.x/api/plugins/_meta.json b/website/src/5.x/api/plugins/_meta.json
@@ -4,6 +4,11 @@
     "name": "index",
     "label": "Overview"
   },
+  {
+    "type": "file",
+    "name": "repack",
+    "label": "RepackPlugin"
+  },
   {
     "type": "file",
     "name": "code-signing",
@@ -13,5 +18,10 @@
     "type": "file",
     "name": "chunks-to-hermes",
     "label": "ChunksToHermesBytecodePlugin"
+  },
+  {
+    "type": "file",
+    "name": "internal",
+    "label": "Internal plugins"
   }
 ]
diff --git a/website/src/5.x/api/plugins/internal.md b/website/src/5.x/api/plugins/internal.md
@@ -0,0 +1,7 @@
+# Internal plugins
+
+## OutputPlugin
+## LoggerPlugin
+## NativeEntryPlugin
+## DevelopmentPlugin
+## RepackTargetPlugin
diff --git a/website/src/5.x/api/plugins/repack.md b/website/src/5.x/api/plugins/repack.md
@@ -0,0 +1 @@
+# RepackPlugin
diff --git a/website/src/5.x/api/runtime/_meta.json b/website/src/5.x/api/runtime/_meta.json
@@ -0,0 +1 @@
+["script", "script-manager"]
diff --git a/website/src/5.x/api/runtime/script-manager.md b/website/src/5.x/api/runtime/script-manager.md
@@ -0,0 +1 @@
+# ScriptManager
diff --git a/website/src/5.x/api/runtime/script.md b/website/src/5.x/api/runtime/script.md
@@ -0,0 +1 @@
+# Script
diff --git a/website/src/5.x/api/utils.md b/website/src/5.x/api/utils.md
@@ -0,0 +1,8 @@
+# Configuration utilities
+
+## constants
+## getDirname
+## getModulePaths
+## getPublicPath
+## getResolveOptions
+
diff --git a/website/src/5.x/docs/_meta.json b/website/src/5.x/docs/_meta.json
@@ -5,7 +5,9 @@
     "label": "Getting Started"
   },
   {
-    "type": "divider"
+    "type": "dir",
+    "name": "features",
+    "label": "Features"
   },
   {
     "type": "dir",
@@ -14,12 +16,12 @@
   },
   {
     "type": "dir",
-    "name": "configuration",
-    "label": "Configuration"
+    "name": "migration-guides",
+    "label": "Migration"
   },
   {
     "type": "dir",
-    "name": "migration",
-    "label": "Migration"
+    "name": "resources",
+    "label": "Additional resources"
   }
 ]
diff --git a/website/src/5.x/docs/configuration/templates.mdx b/website/src/5.x/docs/configuration/templates.mdx
diff --git a/website/src/5.x/docs/configuration/webpack-config.mdx b/website/src/5.x/docs/configuration/webpack-config.mdx
diff --git a/website/src/5.x/docs/features/_meta.json b/website/src/5.x/docs/features/_meta.json
@@ -0,0 +1,9 @@
+[
+  "code-splitting",
+  "module-federation",
+  "module-resolution",
+  "dev-server",
+  "flow-support",
+  "devtools",
+  "reanimated"
+]
diff --git a/website/src/5.x/docs/features/code-splitting.md b/website/src/5.x/docs/features/code-splitting.md
@@ -0,0 +1 @@
+# Code splitting
diff --git a/website/src/5.x/docs/features/dev-server.md b/website/src/5.x/docs/features/dev-server.md
@@ -0,0 +1 @@
+# DevServer
diff --git a/website/src/5.x/docs/features/devtools.md b/website/src/5.x/docs/features/devtools.md
@@ -0,0 +1 @@
+# React Native Devtools
diff --git a/website/src/5.x/docs/features/flow-support.md b/website/src/5.x/docs/features/flow-support.md
@@ -0,0 +1 @@
+# Flow language support
diff --git a/website/src/5.x/docs/features/module-federation.md b/website/src/5.x/docs/features/module-federation.md
@@ -0,0 +1 @@
+# Module Federation
diff --git a/website/src/5.x/docs/features/module-resolution.md b/website/src/5.x/docs/features/module-resolution.md
@@ -0,0 +1 @@
+# Module resolution
diff --git a/website/src/5.x/docs/features/reanimated.md b/website/src/5.x/docs/features/reanimated.md
@@ -0,0 +1 @@
+# React Native Reanimated
diff --git a/website/src/5.x/docs/getting-started/_meta.json b/website/src/5.x/docs/getting-started/_meta.json
@@ -1 +1 @@
-["introduction", "quick-start", "known-issues"]
+["introduction", "quick-start", "microfrontends", "bundlers"]
diff --git a/website/src/5.x/docs/getting-started/bundlers.md b/website/src/5.x/docs/getting-started/bundlers.md
@@ -0,0 +1 @@
+# Rspack & webpack
diff --git a/website/src/5.x/docs/getting-started/introduction.md b/website/src/5.x/docs/getting-started/introduction.md
@@ -1,4 +1,4 @@
-# About Re.Pack
+# Introduction
 
 Before diving deep into Re.Pack and introducing it into project, it's important to understand when and why to use Re.Pack and how does it compare with alternatives.
 

diff --git a/website/src/5.x/docs/getting-started/microfrontends.md b/website/src/5.x/docs/getting-started/microfrontends.md
@@ -0,0 +1 @@
+# Micro Frontends
diff --git a/website/src/5.x/docs/getting-started/quick-start.mdx b/website/src/5.x/docs/getting-started/quick-start.mdx
@@ -1,6 +1,6 @@
 import { PackageManagerTabs, Steps } from 'rspress/theme';
 
-# Quick Start
+# Quick start
 
 ## Pre-requisites
 

diff --git a/website/src/5.x/docs/guides/_meta.json b/website/src/5.x/docs/guides/_meta.json
@@ -1 +1,8 @@
-["inline-assets", "remote-assets", "svg", "lazy-compilation"]
+[
+  "configuration",
+  "debugging",
+  "bundle-analysis",
+  "inline-assets",
+  "remote-assets",
+  "svg"
+]
diff --git a/website/src/5.x/docs/guides/bundle-analysis.md b/website/src/5.x/docs/guides/bundle-analysis.md
@@ -0,0 +1 @@
+# Bundle analysis
diff --git a/website/src/5.x/docs/guides/configuration.md b/website/src/5.x/docs/guides/configuration.md
@@ -0,0 +1 @@
+# Configuration
diff --git a/website/src/5.x/docs/guides/debugging.md b/website/src/5.x/docs/guides/debugging.md
@@ -0,0 +1 @@
+# Debugging
diff --git a/website/src/5.x/docs/guides/inline-assets.md b/website/src/5.x/docs/guides/inline-assets.md
@@ -1,4 +1,4 @@
-# Inlining Assets
+# Inlining assets
 
 There are some situations when you might want to inline assets into the JavaScript bundle, instead of extracting them into standalone files.
Original file line number	Diff line number	Diff line change
		@@ -1 +1 @@
		["introduction", "quick-start", "known-issues"]
		["introduction", "quick-start", "microfrontends", "bundlers"]