Improve docs (#90)

* Add method * Remove unnecessary shadowed variable * Separate pages
Ukendio · Jul 28, 2024 · a3eb2cd · a3eb2cd
1 parent 49305f7
commit a3eb2cd
Show file tree

Hide file tree

Showing 9 changed files with 199 additions and 189 deletions.
diff --git a/docs/.vitepress/config.mts b/docs/.vitepress/config.mts
@@ -2,56 +2,66 @@ import { defineConfig } from 'vitepress'
 
 // https://vitepress.dev/reference/site-config
 export default defineConfig({
-  title: "Jecs",
-  base: "/jecs/",
-  description: "A VitePress Site",
-  themeConfig: {
-    // https://vitepress.dev/reference/default-theme-config
-    nav: [
-      { text: 'Home', link: '/' },
-      { text: 'Examples', link: '/markdown-examples' }
-    ],
+    title: "Jecs",
+    base: "/jecs/",
+    description: "A VitePress Site",
+    themeConfig: {
+        // https://vitepress.dev/reference/default-theme-config
+        nav: [
+            { text: 'Home', link: '/' },
+            { text: 'Examples', link: '/markdown-examples' },
+            { text: 'API', link: '/api/jecs.md' }
+        ],
 
-    sidebar: [
-      {
-        text: 'Overview',
-        items: [
-          { text: 'Getting Started', link: '/overview/get-started' },
-          { text: 'First Jecs Project', link: '/overview/first-jecs-project' }
-        ]
-      },
-      {
-        text: 'Concepts',
-        items: [
-          { text: 'Entities', link: '/concepts/entities' },
-          { text: 'Static Components', link: '/concepts/static-components' },
-          { text: 'Queries', link: '/concepts/queries' },
-        ]
-      },
-      {
-        text: 'References',
-        items: [
-          { text: 'API Reference', link: '/api' },
-        ]
-      },
-      {
-        text: "FAQ",
-        items: [
-          { text: 'How can I contribute?', link: '/faq/contributing' }
-        ]
-      },
-      {
-        text: 'Contributing',
-        items: [
-          { text: 'Contribution Guidelines', link: '/contributing/guidelines'},
-          { text: 'Submitting Issues', link: '/contributing/issues'},
-          { text: 'Submitting Pull Requests', link: '/contributing/pull-requests'},
-        ]
-      }
-    ],
+        sidebar: {
+            "/api/": [
+                {
+                    text: "API reference",
+                    items: [
+                        { text: "jecs", link: "/api/jecs" },
+                        { text: "World", link: "/api/world" },
+                        { text: "Query", link: "/api/query" }
+                    ]
+                }
+            ],
+            "/learn/": [
+                {
+                    text: "Introduction",
+                    items: [
+                        { text: 'Getting Started', link: '/overview/get-started' },
+                        { text: 'First Jecs Project', link: '/overview/first-jecs-project' }
+                    ]
+                },
+                {
+                    text: 'Concepts',
+                    items: [
+                        { text: 'Entities', link: '/concepts/entities' },
+                        { text: 'Static Components', link: '/concepts/static-components' },
+                        { text: 'Queries', link: '/concepts/queries' },
+                    ]
+                },
+                {
+                    text: "FAQ",
+                    items: [
+                        { text: 'How can I contribute?', link: '/faq/contributing' }
+                    ]
+                },
+
+            ],
+            "/contributing/": [
+                {
+                    text: 'Contributing',
+                    items: [
+                        { text: 'Contribution Guidelines', link: '/contributing/guidelines' },
+                        { text: 'Submitting Issues', link: '/contributing/issues' },
+                        { text: 'Submitting Pull Requests', link: '/contributing/pull-requests' },
+                    ]
+                }
+            ]
+        },
 
-    socialLinks: [
-      { icon: 'github', link: 'https://github.com/vuejs/vitepress' }
-    ]
-  }
+        socialLinks: [
+            { icon: 'github', link: 'https://github.com/vuejs/vitepress' }
+        ]
+    }
 })
diff --git a/docs/concepts/entities.md → docs/learn/concepts/entities.md b/docs/concepts/entities.md → docs/learn/concepts/entities.md
@@ -1 +1 @@
-
+
diff --git a/docs/concepts/queries.md → docs/learn/concepts/queries.md b/docs/concepts/queries.md → docs/learn/concepts/queries.md
@@ -1,3 +1,3 @@
-## TODO
-
+## TODO
+
 This is a TODO stub.
diff --git a/docs/concepts/static-components.md → docs/learn/concepts/static-components.md b/docs/concepts/static-components.md → docs/learn/concepts/static-components.md
@@ -1,3 +1,3 @@
-## TODO
-
+## TODO
+
 This is a TODO stub.
diff --git a/docs/faq/contributing.md → docs/learn/faq/contributing.md b/docs/faq/contributing.md → docs/learn/faq/contributing.md
@@ -1,3 +1,3 @@
-## TODO
-
+## TODO
+
 This is a TODO stub.
diff --git a/docs/overview/first-jecs-project.md → docs/learn/overview/first-jecs-project.md b/docs/overview/first-jecs-project.md → docs/learn/overview/first-jecs-project.md
@@ -1,3 +1,3 @@
-## TODO
-
+## TODO
+
 This is a TODO stub.