Merge pull request #2 from eshtek/dev

Dev

Author: csmanel

.vscode/settings.json

@@ -1,22 +1,22 @@
-{
-  "workbench.colorCustomizations": {
-    "activityBar.activeBackground": "#b6bdbf",
-    "activityBar.background": "#b6bdbf",
-    "activityBar.foreground": "#15202b",
-    "activityBar.inactiveForeground": "#15202b99",
-    "activityBarBadge.background": "#c758ae",
-    "activityBarBadge.foreground": "#15202b",
-    "commandCenter.border": "#15202b99",
-    "sash.hoverBorder": "#b6bdbf",
-    "statusBar.background": "#9ba4a7",
-    "statusBar.foreground": "#15202b",
-    "statusBarItem.hoverBackground": "#808b8f",
-    "statusBarItem.remoteBackground": "#9ba4a7",
-    "statusBarItem.remoteForeground": "#15202b",
-    "titleBar.activeBackground": "#9ba4a7",
-    "titleBar.activeForeground": "#15202b",
-    "titleBar.inactiveBackground": "#9ba4a799",
-    "titleBar.inactiveForeground": "#15202b99"
-  },
-  "peacock.color": "#9ba4a7"
-}
+// {
+//   "workbench.colorCustomizations": {
+//     "activityBar.activeBackground": "#b6bdbf",
+//     "activityBar.background": "#b6bdbf",
+//     "activityBar.foreground": "#15202b",
+//     "activityBar.inactiveForeground": "#15202b99",
+//     "activityBarBadge.background": "#c758ae",
+//     "activityBarBadge.foreground": "#15202b",
+//     "commandCenter.border": "#15202b99",
+//     "sash.hoverBorder": "#b6bdbf",
+//     "statusBar.background": "#9ba4a7",
+//     "statusBar.foreground": "#15202b",
+//     "statusBarItem.hoverBackground": "#808b8f",
+//     "statusBarItem.remoteBackground": "#9ba4a7",
+//     "statusBarItem.remoteForeground": "#15202b",
+//     "titleBar.activeBackground": "#9ba4a7",
+//     "titleBar.activeForeground": "#15202b",
+//     "titleBar.inactiveBackground": "#9ba4a799",
+//     "titleBar.inactiveForeground": "#15202b99"
+//   },
+//   // "peacock.color": "#9ba4a7"
+// }

docs/.vitepress/nav.ts

@@ -2,8 +2,11 @@ import type { DefaultTheme } from 'vitepress'
 
 const nav: DefaultTheme.NavItem[] = [
   { text: 'Home', link: '/' },
-  { text: 'Install Scripts', link: '/install-scripts/overview' },
-
+  { text: 'Getting Started', link: '/getting-started/overview' },
+  { text: 'Features', link: '/features/' },
+  { text: 'Troubleshooting', link: '/troubleshooting/' },
+  { text: 'Community', link: '/community/' },
+  { text: 'Licensing', link: '/licensing/' },
 ]
 
 export default nav

docs/.vitepress/sidebar.ts

@@ -1,16 +1,63 @@
 import type { DefaultTheme } from 'vitepress'
 
 const sidebar: DefaultTheme.Sidebar = {
-  '/install-scripts/': [
+  '/getting-started/': [
     {
-      text: 'Install Scripts',
+      text: 'Getting Started',
       items: [
-        { text: 'Overview', link: '/install-scripts/overview' },
-        { text: 'Apps (Curated Scripts)', link: '/install-scripts/curated/' },
-        { text: 'Contributing', link: '/install-scripts/contributing' },
-        { text: 'Reference: Schema', link: '/install-scripts/reference/schema' },
-        { text: 'Reference: Macros', link: '/install-scripts/reference/macros' },
-        { text: 'Advanced: Debugging', link: '/install-scripts/advanced/debugging' },
+        { text: 'Overview', link: '/getting-started/overview' },
+        { text: 'Install HexOS', link: '/getting-started/installation/InstallGuide' },
+        { text: 'Complete Setup', link: '/getting-started/setup/CompleteSetup' },
+      ]
+    }
+  ],
+  '/features/': [
+    {
+      text: 'Features',
+      items: [
+        { text: 'Overview', link: '/features/' },
+        { text: 'Storage', link: '/features/storage/storage' },
+        { text: 'Folders', link: '/features/folders/' },
+        { text: 'Apps', link: '/features/apps/',
+          items: [
+            { text: 'Install Scripts Overview', link: '/features/apps/install-scripts/overview' },
+            { text: 'Curated Scripts', link: '/features/apps/install-scripts/curated/' },
+            { text: 'Contributing', link: '/features/apps/install-scripts/contributing' },
+            { text: 'Schema Reference', link: '/features/apps/install-scripts/reference/schema' },
+            { text: 'Macros Reference', link: '/features/apps/install-scripts/reference/macros' },
+            { text: 'Debugging', link: '/features/apps/install-scripts/advanced/debugging' },
+          ]
+        },
+        { text: 'Notifications', link: '/features/notifications/' },
+        { text: 'Settings', link: '/features/settings/',
+          items: [
+            { text: 'Experimental Features', link: '/features/settings/experimental-features/' },
+          ]
+        },
+      ],
+    }
+  ],
+  '/troubleshooting/': [
+    {
+      text: 'Troubleshooting',
+      items: [
+        { text: 'Common Issues', link: '/troubleshooting/' },
+      ]
+    }
+  ],
+  '/community/': [
+    {
+      text: 'Community',
+      items: [
+        { text: 'How to Contribute', link: '/community/' },
+      ]
+    }
+  ],
+  '/licensing/': [
+    {
+      text: 'Licensing',
+      items: [
+        { text: 'Usage Rights', link: '/licensing/' },
       ]
     }
   ],
@@ -19,7 +66,11 @@ const sidebar: DefaultTheme.Sidebar = {
       text: 'Documentation',
       items: [
         { text: 'Home', link: '/' },
-        { text: 'Install Scripts', link: '/install-scripts/overview' }
+        { text: 'Getting Started', link: '/getting-started/overview' },
+        { text: 'Features', link: '/features/' },
+        { text: 'Troubleshooting', link: '/troubleshooting/' },
+        { text: 'Community', link: '/community/' },
+        { text: 'Licensing', link: '/licensing/' },
       ]
     }
   ]

docs/InstallGuide.md

@@ -0,0 +1,23 @@
+# Community Contributions
+
+HexOS grows stronger with community involvement. Whether you're a developer, writer, or enthusiast, there are many ways to contribute to the project and help other users.
+
+## Help Curate Applications (Install Scripts)
+
+One of the most valuable contributions is helping expand the available applications. You can test existing community scripts and provide feedback, create install scripts for new applications, improve documentation with setup guides and troubleshooting tips, or help review submissions for quality and compatibility.
+
+## Write and Submit Code
+
+Developers can contribute directly to the HexOS codebase by fixing bugs, enhancing existing features, optimizing performance, or adding automated tests. The process involves forking the repository, making your changes, and submitting a pull request for review by the HexOS team.
+
+## Improve Our Documentation
+
+Documentation improvements are always welcome. Fix errors and outdated information, fill gaps for missing features, rewrite confusing sections to be clearer, or add real-world examples and use cases. Documentation contributions follow the same pull request process as code.
+
+## Support Other Users
+
+Help build a supportive community on our forums and Reddit. Share your knowledge to solve problems, post working configurations for common setups, help debug tricky issues, and welcome newcomers to make the community friendly for new users.
+
+## Apply to be a Moderator
+
+Experienced community members can apply to help moderate forums and maintain a positive environment. This involves community leadership, content moderation, conflict resolution, and helping the community grow. Applications are reviewed based on community involvement, technical knowledge, and communication skills.

docs/community/index.md

@@ -0,0 +1,24 @@
+# Apps
+
+This is where all your applications live. You can install curated apps with one click, use community contributions, create custom installs, or go through the full TrueNAS catalog.
+
+## Eshtek Curations
+
+The HexOS team has created curated install scripts that handle all the configuration automatically, so you just click install and everything works. Over time we will continue to expand the curated section even further.
+
+## Community Curations
+
+Community members can contribute app curations to expand what's available beyond the official catalog. If there's an app you want but don't see a curation for it, you can make one yourself.
+
+*(I imagine we should talk about the process of adding their curations?)*
+
+## Install Scripts
+
+For non-curated apps, you can use custom install scripts to get them running. You can also view and modify the install scripts to fit your specific needs.  
+This requires enabling [experimental features](/features/settings/#preferences) in your preferences.
+
+Learn more about [install scripts](/features/apps/install-scripts/overview). 
+
+## TrueNAS Catalog
+
+For advanced users who want access to everything, the full TrueNAS app catalog gives you hundreds of applications with complete control over their configuration. You're on your own for setup and troubleshooting, but you get maximum flexibility.

docs/features/apps/index.md

@@ -0,0 +1,10 @@
+# Contributing a new app
+
+Want to add your app curation to the official HexOS catalog? Follow these steps to contribute your install script, or share it in our forums first to get community feedback:
+
+1. Test your custom curation in HexOS and verify it works reliably
+2. Click [Here](https://github.com/eshtek/hexos-docs/new/main/docs/public/install-scripts) to start the contribution process
+3. Click the green "Fork this repository" button
+4. Paste the contents of your install script into the editor and press the green "Commit Changes"
+5. Click the green "Create pull request" on the following page
+6. In your PR description, include any special requirements (unique mounts, GPU usage, special environment variables, etc.)