Docs: Added a getting started section (#799)

Author: yaira2

src/data/docsTree.ts

@@ -2,64 +2,84 @@ import type { DocsMetadata, DocsNode, DocsTree } from "$data/docs";
 import { error } from "@sveltejs/kit";
 
 const PATH_TRIM = /(?:\.\.\/routes\/docs)((\/[\w-]+)+)\//;
+const PRIORITY_CATEGORY = "Getting Started";
+const PRIORITY_PAGES = ["Overview", "Install"];
 
 const getPages = () => {
-	const rawPages = import.meta.glob<DocsMetadata>(
-		["../routes/docs/**/*/+page.md", "../routes/docs/+page.md"], // import all docs pages + base page
-		{ eager: true, import: "metadata" },
-	);
+    const rawPages = import.meta.glob<DocsMetadata>(
+        ["../routes/docs/**/*/+page.md", "../routes/docs/+page.md"],
+        { eager: true, import: "metadata" },
+    );
 
-	return Object.entries(rawPages).map(([path, node]) => {
-		return {
-			title: node.title,
-			path: path.match(PATH_TRIM)?.[1] ?? "",
-		} as DocsNode;
-	});
+    return Object.entries(rawPages).map(([path, node]) => {
+        return {
+            title: node.title,
+            path: path.match(PATH_TRIM)?.[1] ?? "",
+        } as DocsNode;
+    });
 };
 
 const getTree = (pages: DocsNode[]) => {
-	const rawCategories = import.meta.glob<DocsMetadata>(
-		"../routes/docs/**/*/category.md",
-		{
-			eager: true,
-			import: "metadata",
-		},
-	);
+    const rawCategories = import.meta.glob<DocsMetadata>(
+        "../routes/docs/**/*/category.md",
+        {
+            eager: true,
+            import: "metadata",
+        },
+    );
 
-	const categories: DocsTree = Object.entries(rawCategories).map(
-		([path, node]) => {
-			const docsPath = path.match(PATH_TRIM)?.[1];
-			if (!docsPath) error(500, `this is an invalid docs page path: ${path}`);
+    const categories: DocsTree = Object.entries(rawCategories).map(
+        ([path, node]) => {
+            const docsPath = path.match(PATH_TRIM)?.[1];
+            if (!docsPath) error(500, `this is an invalid docs page path: ${path}`);
 
-			return {
-				pages: pages.filter(page => page.path.startsWith(docsPath)),
-				path: docsPath,
-				...node,
-			};
-		},
-	);
+            const categoryPages = pages
+                .filter(page => page.path.startsWith(docsPath))
+                .sort((a, b) => {
+                    const aIndex = PRIORITY_PAGES.indexOf(a.title);
+                    const bIndex = PRIORITY_PAGES.indexOf(b.title);
 
-	const topLevelPages = import.meta.glob<DocsMetadata>(
-		["../routes/docs/*/+page.md", "../routes/docs/+page.md"],
-		{
-			eager: true,
-			import: "metadata",
-		},
-	);
+                    if (aIndex !== -1 && bIndex !== -1) return aIndex - bIndex;
+                    if (aIndex !== -1) return -1;
+                    if (bIndex !== -1) return 1;
 
-	const topLevelData: DocsNode[] = Object.entries(topLevelPages).map(
-		([path, data]) => {
-			const docsPath = path.match(PATH_TRIM)?.[1] ?? "";
+                    return a.title.localeCompare(b.title);
+                });
 
-			return {
-				path: docsPath,
-				...data,
-			};
-		},
-	);
+            return {
+                pages: categoryPages,
+                path: docsPath,
+                ...node,
+            };
+        },
+    );
 
-	return [...topLevelData, ...categories];
+    const topLevelPages = import.meta.glob<DocsMetadata>(
+        ["../routes/docs/*/+page.md", "../routes/docs/+page.md"],
+        {
+            eager: true,
+            import: "metadata",
+        },
+    );
+
+    const topLevelData: DocsNode[] = Object.entries(topLevelPages).map(
+        ([path, data]) => {
+            const docsPath = path.match(PATH_TRIM)?.[1] ?? "";
+
+            return {
+                path: docsPath,
+                ...data,
+            };
+        },
+    );
+
+    // Combine and apply category-level sort
+    return [...topLevelData, ...categories].sort((a, b) => {
+        if (a.title === PRIORITY_CATEGORY) return -1;
+        if (b.title === PRIORITY_CATEGORY) return 1;
+        return a.title.localeCompare(b.title);
+    });
 };
 
 export const docsPages = getPages();
-export const docsTree = getTree(docsPages);
+export const docsTree = getTree(docsPages);

src/routes/docs/+page.server.ts

@@ -0,0 +1,5 @@
+import { redirect } from "@sveltejs/kit";
+
+export const load = ({ params }) => {
+	redirect(301, `/docs/getting-started/overview/${params.rest ?? ""}`);
+};

src/routes/docs/getting-started/category.md

@@ -0,0 +1,3 @@
+---
+title: Getting Started
+---

src/routes/docs/getting-started/faq/+page.md

@@ -0,0 +1,41 @@
+---
+title: Frequently Asked Questions
+---
+
+## How to Locate the Log File
+
+If Files launches successfully, the easiest way to access its log file is directly from **Settings → About → Open log location.**. If you're unable to open the UI, you can locate the log manually using File Explorer. The path varies depending on which version of Files is installed:
+
+### Files Stable (Microsoft Store)
+
+```text
+%LocalAppData%\\Packages\\49306atecsolution.FilesUWP_et10x9a9vyk8t\\LocalState
+```
+
+### Files Stable (Sideload)
+
+```text
+%LocalAppData%\\Packages\\Files_1y0xx7n9077q4\\LocalState
+```
+
+### Files Preview (Microsoft Store)
+
+```text
+%LocalAppData%\\Packages\\49306atecsolution.FilesPreview_et10x9a9vyk8t\\LocalState
+```
+
+### Files Preview (Sideload)
+
+```text
+%LocalAppData%\\Packages\\FilesPreview_1y0xx7n9077q4\\LocalState
+```
+
+## How to Improve Performance
+
+The default settings are designed to deliver the best performance across different environments. We've identified several areas with potential for further optimization and are actively working on improvements behind the scenes.
+
+## How to Reduce Memory Usage
+
+Resource consumption naturally increases when opening new tabs or navigating to different locations. However, we're aware of several memory leaks that can cause usage to accumulate over extended sessions.
+
+To mitigate this, consider disabling the option to keep Files in the background from **Settings → Advanced → Leave app running in the background when the window is closed**. Note that turning this off may result in slower launch times for Files. We're investigating these leaks and looking for a long-term solution.

src/routes/docs/install/+page.md renamed to src/routes/docs/getting-started/install/+page.md

@@ -0,0 +1,5 @@
+import { redirect } from "@sveltejs/kit";
+
+export const load = ({ params }) => {
+	redirect(301, `/docs/getting-started/install/${params.rest ?? ""}`);
+};