Merge pull request #13 from eshtek/dev

Dev

Author: csmanel

docs/.vitepress/sidebar.ts

@@ -74,11 +74,17 @@ const sidebar: DefaultTheme.Sidebar = {
       items: [
         { text: 'Command Deck', link: '/release-notes/command-deck/',
           items: [
+            // auto-generated-release-notes-start
+            { text: 'September 29, 2025', link: '/release-notes/command-deck/2025-09-29' },
+            { text: 'July 28, 2025', link: '/release-notes/command-deck/2025-07-28' },
+            { text: 'July 7, 2025', link: '/release-notes/command-deck/2025-07-07' },
+            { text: 'June 27, 2025', link: '/release-notes/command-deck/2025-06-27' },
             { text: 'February 7, 2025', link: '/release-notes/command-deck/2025-02-07' },
             { text: 'January 8, 2025', link: '/release-notes/command-deck/2025-01-08' },
             { text: 'July 24, 2024', link: '/release-notes/command-deck/2024-07-24' },
             { text: 'July 4, 2024', link: '/release-notes/command-deck/2024-07-04' },
             { text: 'June 27, 2024', link: '/release-notes/command-deck/2024-06-27' },
+            // auto-generated-release-notes-end
           ]
         },
       ]

docs/release-notes/command-deck/2025-06-27.md

@@ -0,0 +1,32 @@
+# Q2 Command Deck Update - June 27, 2025
+
+## Key Features
+
+### Manual Pool Configuration
+Customize your storage pools with granular control over drive participation. This even includes the ability to create 1-drive pools (without redundancy or expandability). This applies to both our setup wizard and the main storage page itself. Proper warnings are displayed based on the risk profile of the pool being configured. In addition, users that previously "disconnected" (this process is now referred to as "Unclaiming") their server from HexOS can easily reconnect through the setup wizard without being forced to recreate their storage pools from scratch (just click "skip" when on the storage configuration page of the wizard).
+
+### New Activity Center
+The Health card has been replaced with Activity. Activity tracks everything you do in HexOS: our custom orchestration, server events, alerts, updates, and dismissals. Dismissed activities are reviewable from the activity archive.
+
+### Update to TrueNAS SCALE 24.10.2.2
+Another benefit of the new activity center is the ability to update the OS running on your local server itself. You will find the ability to update the OS also in the new Activity Center on the Dashboard.
+
+### User Settings & Preferences Improvements
+Light or dark theme, preferred language, hidden dashboard cards, these all now sync and persist across browser sessions. The dashboard is yours to shape and customize as you see fit.
+
+### UI and Stability Improvements
+Improved card layout and polish across the UI, the password field now supports toggling visibility, username character limit raised to 30, and plenty of behind the scenes stability fixes.
+
+### Customizable Location Preferences
+You can now set exactly your performance versus capacity pools, app locations and other storage preferences that allow our one click installs to work. Works across all curated and custom apps.
+
+## How to Update
+
+Updating the Command Deck itself is an action performed by the HexOS development team. Users are not required to perform any action to receive the update. It will appear automatically upon login after it goes live.
+
+For users still running the 24.10.0.0 build of TrueNAS SCALE, you will see an "Update Available" notification under the Activity Center once you login. Once you engage the update, **do NOT power off your system**. Wait for the update to download and restart your server automatically. Your system will automatically reconnect to the Command Deck when complete. The time this process can take will vary based on your Internet connection.
+
+## Known Issues
+
+- There is a TrueNAS SCALE bug that affects HexOS users when switching your network configuration from DHCP to Static; manually setting DNS before making this change will prevent the issue; we have a planned hotfix for this as well.
+- Skipping storage pool creation in the wizard allows users to create pools within TrueNAS and they will show up in HexOS; **WARNING:** we have not tested all pool layouts (or sub-pools either), experiment with great caution.

docs/release-notes/command-deck/2025-07-07.md

@@ -0,0 +1,7 @@
+# Command Deck Update - July 7, 2025
+
+We recently merged a few updates to our command deck to improve observability around request timing. This new instrumentation gives us better insight into performance and will help us identify and resolve issues more precisely.
+
+No changes were made to the Command Deck UX in this release.
+
+You might already notice things feel a bit snappier 😉 ... let us know.

docs/release-notes/command-deck/2025-07-28.md

@@ -0,0 +1,12 @@
+# Command Deck Update - July 28, 2025
+
+Another Command Deck update went live today.
+
+This release includes:
+
+- Fixes to the networking layer for users switching between DHCP and static IP modes
+- Improved performance across the app based on the observability metrics added last release
+- A new queuing and caching layer to handle folder loading for users with a large number of folders, preventing API overload with TrueNAS
+- A fix for a bug that caused folders to appear missing when a private folder user had been deleted
+
+Performance work is ongoing. Let us know if you spot anything.

docs/release-notes/command-deck/2025-09-29.md

@@ -0,0 +1,28 @@
+# Command Deck Update - September 29, 2025
+
+New Apps, Curation Process and Folder updates
+
+## Additional Apps
+We've just added Jellyfin, Home Assistant, and qBittorrent! And this is just the beginning, thanks to our new curation process, we expect many more apps to come online soon.
+
+## Intro to App Curation
+We've added an interface to the HexOS frontend to make iterating on apps easier and to let the community contribute their own curations. By enabling Dev Mode in Preferences, you'll unlock the Custom Script option for app installs. From there, you can tweak existing install scripts or create new ones then share them with friends or submit them to the official HexOS curation templates.
+
+Right now, the feature focuses on streamlining the app install process. Soon we plan to surface installer questions directly in the UI and automate post-install steps (such as in-app setup wizards). That work depends on the in-development Local UI project, we will share more news about this in the future.
+
+We'd love your feedback as we refine this, let us know what's working well and where you're running into friction.
+
+If you would like to contribute your curation to the official HexOS app curations you can follow this guide, or just share your install script in our [forums](https://hub.hexos.com/):
+1. Test your custom curation in HexOS and verify it works
+2. Click Here
+3. Click the green "Fork this repository"
+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 callouts (unique mounts, GPU usage, special env, etc.)
+
+## Folder Wizard Arrives
+We've extended our simple folder creation interface with a new wizard-driven process that unlocks specialized use cases like encrypted folders and Time Machine backups. With this foundation in place, we're now ready to move forward on bigger features including Snapshots, Replication, and Buddy Backup.
+
+---
+
+**NOTE:** This update was applied automatically. You may need to clear your cache. Help with clearing you cache is available [here](/troubleshooting/common-issues/ClearCache).

docs/release-notes/command-deck/index.md

@@ -8,17 +8,22 @@ Command Deck updates are automatically deployed by the HexOS development team. Y
 
 For users who are actively connected during an update, there may be a brief downtime of a minute or two as the new version is deployed.
 
+<!-- auto-generated-year-sections-start -->
 ## 2025 Releases
 
-- [**February 7, 2025**](./2025-02-07) - Setup wizard improvements, data detection, UI enhancements
-- [**January 8, 2025**](./2025-01-08) - Manual WAN IP specification, UI improvements, bug fixes
+- [**September 29, 2025**](./2025-09-29) - Updates and improvements
+- [**July 28, 2025**](./2025-07-28) - Updates and improvements
+- [**July 7, 2025**](./2025-07-07) - Updates and improvements
+- [**June 27, 2025**](./2025-06-27) - Updates and improvements
+- [**February 7, 2025**](./2025-02-07) - Improved Setup Wizard Functionality, Existing Data Detection, Minor UI Improvements
+- [**January 8, 2025**](./2025-01-08) - Updates and improvements
 
 ## 2024 Releases
 
-- [**July 24, 2024**](./2024-07-24) - Networking fixes, performance improvements, folder loading optimization
-- [**July 4, 2024**](./2024-07-04) - Performance monitoring improvements
-- [**June 27, 2024**](./2024-06-27) - Manual pool configuration, Activity Center, TrueNAS SCALE 24.10.2.2 update
-
+- [**July 24, 2024**](./2024-07-24) - Networking Fixes, Performance Improvements, Folder Loading Optimization
+- [**July 4, 2024**](./2024-07-04) - Updates and improvements
+- [**June 27, 2024**](./2024-06-27) - Updates and improvements
+<!-- auto-generated-year-sections-end -->
 
 ## Need Help?
 

package.json

@@ -4,11 +4,13 @@
   "private": true,
   "type": "module",
   "scripts": {
-    "gen:curated": "node scripts/generate-curated-index.mjs",
-    "docs:dev": "npm run gen:curated && vitepress dev docs",
+    "gen:curated": "node scripts/generateCuratedIndex.mjs",
+    "gen:release-notes": "node scripts/generateReleaseNotesIndex.mjs",
+    "gen:all": "npm run gen:curated && npm run gen:release-notes",
+    "docs:dev": "npm run gen:all && vitepress dev docs",
     "dev": "npm run docs:dev",
-    "docs:dev:here": "DOCS_DIR=. node scripts/generate-curated-index.mjs && vitepress dev .",
-    "docs:build": "npm run gen:curated && vitepress build docs",
+    "docs:dev:here": "DOCS_DIR=. node scripts/generateCuratedIndex.mjs && node scripts/generateReleaseNotesIndex.mjs && vitepress dev .",
+    "docs:build": "npm run gen:all && vitepress build docs",
     "docs:serve": "vitepress serve docs"
   },
   "devDependencies": {

scripts/generate-curated-index.mjs scripts/generateCuratedIndex.mjsscripts/generate-curated-index.mjs renamed to scripts/generateCuratedIndex.mjs

@@ -0,0 +1,230 @@
+#!/usr/bin/env node
+import fs from 'fs'
+import path from 'path'
+import { fileURLToPath } from 'url'
+
+const __dirname = path.dirname(fileURLToPath(import.meta.url))
+const DOCS_DIR = process.env.DOCS_DIR || 'docs'
+
+const RELEASE_NOTES_DIR = path.resolve(__dirname, '..', DOCS_DIR, 'release-notes/command-deck')
+const INDEX_MD = path.resolve(RELEASE_NOTES_DIR, 'index.md')
+const SIDEBAR_TS = path.resolve(__dirname, '..', DOCS_DIR, '.vitepress/sidebar.ts')
+
+// Sidebar automation markers
+const SIDEBAR_START = '// auto-generated-release-notes-start'
+const SIDEBAR_END = '// auto-generated-release-notes-end'
+
+// Dynamic year section markers
+const YEAR_SECTIONS_START = '<!-- auto-generated-year-sections-start -->'
+const YEAR_SECTIONS_END = '<!-- auto-generated-year-sections-end -->'
+
+function parseReleaseNote(filePath) {
+  try {
+    const content = fs.readFileSync(filePath, 'utf8')
+    const lines = content.split('\n')
+
+    // Get title from first heading
+    const titleLine = lines.find(line => line.startsWith('# '))
+    const title = titleLine ? titleLine.replace('# ', '') : 'Unknown'
+
+    // Extract date from filename (YYYY-MM-DD.md)
+    const filename = path.basename(filePath, '.md')
+    const dateMatch = filename.match(/(\d{4})-(\d{2})-(\d{2})/)
+
+    if (!dateMatch) return null
+
+    const [, year, month, day] = dateMatch
+    const date = new Date(year, month - 1, day)
+    const formattedDate = date.toLocaleDateString('en-US', {
+      year: 'numeric',
+      month: 'long',
+      day: 'numeric'
+    })
+
+    // Generate description from content (look for key features or main points)
+    let description = ''
+    let inKeyFeatures = false
+    let features = []
+
+    for (const line of lines) {
+      if (line.startsWith('## Key Features') || line.startsWith('## Additional Apps')) {
+        inKeyFeatures = true
+        continue
+      }
+      if (line.startsWith('##') && inKeyFeatures) {
+        break
+      }
+      if (inKeyFeatures && line.startsWith('- ') || line.startsWith('### ')) {
+        const feature = line.replace(/^- \*\*|\*\*|^### /g, '').split(' - ')[0].split(':')[0]
+        if (feature && !features.includes(feature)) {
+          features.push(feature)
+        }
+      }
+    }
+
+    description = features.length > 0 ? features.slice(0, 3).join(', ') : 'Updates and improvements'
+
+    return {
+      filename,
+      title,
+      formattedDate,
+      description,
+      year: parseInt(year),
+      sortDate: date
+    }
+  } catch (error) {
+    console.warn(`Could not parse ${filePath}:`, error.message)
+    return null
+  }
+}
+
+function buildReleaseList(releases) {
+  if (!releases.length) return '_No releases found._'
+
+  // Sort by date descending (newest first)
+  releases.sort((a, b) => b.sortDate - a.sortDate)
+
+  return releases.map(release =>
+    `- [**${release.formattedDate}**](./${release.filename}) - ${release.description}`
+  ).join('\n')
+}
+
+function ensureIndexPage() {
+  if (!fs.existsSync(INDEX_MD)) {
+    fs.mkdirSync(path.dirname(INDEX_MD), { recursive: true })
+    const boilerplate = `# Command Deck Release Notes
+
+Stay up to date with HexOS Command Deck updates, new features, and improvements.
+
+## How Updates Work
+
+Command Deck updates are automatically deployed by the HexOS development team. You don't need to take any action to receive these updates - they will appear automatically when you next visit the Command Deck.
+
+For users who are actively connected during an update, there may be a brief downtime of a minute or two as the new version is deployed.
+
+${YEAR_SECTIONS_START}
+${YEAR_SECTIONS_END}
+
+## Need Help?
+
+If you encounter any issues after an update:
+- Try [clearing your browser cache](/troubleshooting/common-issues/ClearCache) first
+- Check the [troubleshooting guide](/troubleshooting/) for common solutions
+- Visit the [HexOS Community](https://hub.hexos.com/) for additional support
+`
+    fs.writeFileSync(INDEX_MD, boilerplate)
+  }
+}
+
+function updateIndexPage() {
+  ensureIndexPage()
+  let md = fs.readFileSync(INDEX_MD, 'utf8')
+
+  // Ensure year sections markers exist
+  if (!md.includes(YEAR_SECTIONS_START)) {
+    // If no markers, add them after "How Updates Work" section
+    const insertPoint = md.indexOf('## Need Help?')
+    if (insertPoint !== -1) {
+      const before = md.slice(0, insertPoint)
+      const after = md.slice(insertPoint)
+      md = `${before}${YEAR_SECTIONS_START}\n${YEAR_SECTIONS_END}\n\n${after}`
+    }
+  }
+
+  // Get all release note files
+  const files = fs.readdirSync(RELEASE_NOTES_DIR)
+    .filter(f => f.endsWith('.md') && f !== 'index.md' && f.match(/^\d{4}-\d{2}-\d{2}\.md$/))
+
+  const releases = files
+    .map(f => parseReleaseNote(path.join(RELEASE_NOTES_DIR, f)))
+    .filter(r => r !== null)
+
+  // Group by year and sort years descending (newest first)
+  const releasesByYear = releases.reduce((acc, release) => {
+    if (!acc[release.year]) acc[release.year] = []
+    acc[release.year].push(release)
+    return acc
+  }, {})
+
+  const years = Object.keys(releasesByYear).map(Number).sort((a, b) => b - a)
+
+  // Generate year sections
+  const yearSections = years.map(year => {
+    const yearReleases = releasesByYear[year]
+    const content = buildReleaseList(yearReleases)
+    return `## ${year} Releases\n\n${content}`
+  }).join('\n\n')
+
+  // Update the year sections
+  if (md.includes(YEAR_SECTIONS_START) && md.includes(YEAR_SECTIONS_END)) {
+    const before = md.slice(0, md.indexOf(YEAR_SECTIONS_START) + YEAR_SECTIONS_START.length)
+    const after = md.slice(md.indexOf(YEAR_SECTIONS_END))
+    md = `${before}\n${yearSections}\n${after}`
+
+    fs.writeFileSync(INDEX_MD, md)
+    console.log('Wrote', INDEX_MD)
+
+    const yearCounts = years.map(year => `${releasesByYear[year].length} releases for ${year}`).join(', ')
+    console.log(`Found ${yearCounts}`)
+  } else {
+    console.warn('Could not find year section markers in index.md')
+  }
+}
+
+function generateSidebarItems(releases) {
+  if (!releases.length) return ''
+
+  // Sort by date descending (newest first)
+  releases.sort((a, b) => b.sortDate - a.sortDate)
+
+  return releases.map(release =>
+    `            { text: '${release.formattedDate}', link: '/release-notes/command-deck/${release.filename}' },`
+  ).join('\n')
+}
+
+function updateSidebar() {
+  if (!fs.existsSync(SIDEBAR_TS)) {
+    console.warn('Sidebar file not found, skipping sidebar update')
+    return
+  }
+
+  let sidebarContent = fs.readFileSync(SIDEBAR_TS, 'utf8')
+
+  // Get all release note files
+  const files = fs.readdirSync(RELEASE_NOTES_DIR)
+    .filter(f => f.endsWith('.md') && f !== 'index.md' && f.match(/^\d{4}-\d{2}-\d{2}\.md$/))
+
+  const releases = files
+    .map(f => parseReleaseNote(path.join(RELEASE_NOTES_DIR, f)))
+    .filter(r => r !== null)
+
+  const sidebarItems = generateSidebarItems(releases)
+
+  // Add markers if they don't exist
+  if (!sidebarContent.includes(SIDEBAR_START)) {
+    // Find the Command Deck items section and add markers
+    const commandDeckMatch = sidebarContent.match(/({\s*text:\s*'Command Deck',\s*link:\s*'\/release-notes\/command-deck\/',\s*items:\s*\[)([\s\S]*?)(\]\s*},)/m)
+
+    if (commandDeckMatch) {
+      const before = commandDeckMatch[1]
+      const after = commandDeckMatch[3]
+      const replacement = `${before}\n            ${SIDEBAR_START}\n            ${SIDEBAR_END}\n          ${after}`
+      sidebarContent = sidebarContent.replace(commandDeckMatch[0], replacement)
+    }
+  }
+
+  // Update the sidebar items between markers
+  if (sidebarContent.includes(SIDEBAR_START) && sidebarContent.includes(SIDEBAR_END)) {
+    const before = sidebarContent.slice(0, sidebarContent.indexOf(SIDEBAR_START) + SIDEBAR_START.length)
+    const after = sidebarContent.slice(sidebarContent.indexOf(SIDEBAR_END))
+    sidebarContent = `${before}\n${sidebarItems}\n            ${after}`
+
+    fs.writeFileSync(SIDEBAR_TS, sidebarContent)
+    console.log('Updated sidebar.ts with', releases.length, 'release notes')
+  } else {
+    console.warn('Could not find sidebar markers, manual update required')
+  }
+}
+
+updateIndexPage()
+updateSidebar()