Update: Wiki page

Author: Elaina69

.github/workflows/generate-wiki.yml

@@ -7,6 +7,7 @@ on:
       - 'src/**'
       - 'docs/**'
       - 'scripts/generate-wiki.mjs'
+      - '.github/workflows/generate-wiki.yml'
   workflow_dispatch:
 
 permissions:
@@ -62,7 +63,10 @@ jobs:
             cd -
           fi
 
-          # Copy generated wiki pages (overwrite existing auto-generated ones)
+          # Replace generated wiki pages so removed/renamed pages do not linger.
+          find "$WIKI_DIR_TMP" -maxdepth 1 -type f -name '*.md' -delete
+
+          # Copy generated wiki pages.
           cp wiki/*.md "$WIKI_DIR_TMP/"
 
           # Commit and push

docs/DOCUMENTATION-STANDARD.md

@@ -1,54 +1,51 @@
 # Documentation Standard
 
-This project auto-generates wiki pages from source code JSDoc comments. Follow these standards to ensure proper wiki generation.
-
-## Plugin Classes
-
-Add a JSDoc block **directly above** every exported class in `src/src/plugins/`:
-
-```typescript
-/**
- * @wiki Automatically accepts the matchmaking queue when a game is found.
- * @author Lyfhael
- * @modifier Elaina Da Catto
- * @usage
- * 1. Open League Client settings
- * 2. Navigate to **Elaina Theme** → **Plugin Settings**
- * 3. Toggle **Auto Accept** to enabled
- * @settings auto_accept, auto_accept_button
- */
-export class AutoAccept {
-```
+The GitHub Wiki is generated from centralized documentation files. Do not edit generated wiki pages by hand.
+
+## Wiki Sources
+
+| File | Purpose |
+|------|---------|
+| `docs/wiki-content.json` | Page order, installation text, asset instructions, grouped wiki sections, FAQ content. |
+| `docs/settings-meta.json` | Setting categories, descriptions, and value types. |
+| `src/src/config/datastoreDefault.js` | Default values shown in generated setting tables. |
+| `src/src/locales/default.js` | UI labels shown beside setting keys when available. |
+
+The generator no longer depends on editing JSDoc in every plugin file for user-facing wiki content. JSDoc can still be useful for code maintainers, but wiki content should be maintained in `docs/wiki-content.json` and `docs/settings-meta.json`.
+
+## Required Wiki Structure
 
-### Required Tags (enforced by ESLint)
+The generated wiki contains these pages in this order:
 
-| Tag | Purpose | Example |
-|-----|---------|---------|
-| `@wiki` | User-facing feature description (displayed in wiki) | `@wiki Adds a dodge button in champion select` |
+1. Home
+2. Installation instructions
+3. Theme customization
+   - 3.1. Add wallpaper/audio
+   - 3.2. Theme settings
+   - 3.3. Plugins settings
+4. Backup/Restore
+5. FAQ & Troubleshooting
 
-### Recommended Tags
+The order is controlled by the `navigation` array in `docs/wiki-content.json`.
 
-| Tag | Purpose | Example |
-|-----|---------|---------|
-| `@author` | Original author | `@author Elaina Da Catto` |
-| `@modifier` | Who modified the original code | `@modifier Elaina Da Catto` |
-| `@usage` | Step-by-step instructions for end users | See example above |
-| `@settings` | Comma-separated DataStore keys this plugin uses | `@settings dodge-button, auto_accept` |
+## Updating Wiki Content
 
-### Notes
+Use `docs/wiki-content.json` for page text and section grouping.
 
-- Use `@wiki` instead of `@description` for user-facing text. `@description` is also supported but `@wiki` takes priority.
-- The `@usage` tag supports Markdown formatting.
-- The wiki generator also detects `ElainaData.get("key")` / `ElainaData.set("key")` calls to automatically find which settings a plugin uses.
+Common edits:
+
+- Add or rewrite installation instructions in `installation`.
+- Add asset rules or supported formats in `themeCustomization.assets`.
+- Move a setting to another wiki group by editing `themeSettingGroups` or `pluginSettingGroups`.
+- Add FAQ entries in `faq.items`.
+- Add runtime-only settings to `runtimeSettingKeys` when the key is created outside `datastoreDefault.js`.
 
 ## Settings Documentation
 
-Settings descriptions live in `docs/settings-meta.json`. When you add a new setting to `datastoreDefault.js`:
+Every setting displayed in the wiki should have an entry in `docs/settings-meta.json`.
 
-1. Add the key to `docs/settings-meta.json` with a `category`, `description`, and `type`.
-2. The wiki generator will warn about any missing settings.
+Example:
 
-Example entry:
 ```json
 {
     "auto_accept": {
@@ -59,41 +56,36 @@ Example entry:
 }
 ```
 
-### Categories
-
-| Key | Name | Used for |
-|-----|------|----------|
-| `theme-core` | Core Theme | Basic theme behavior, version |
-| `wallpaper-audio` | Wallpaper & Audio | Backgrounds, audio playback |
-| `theme-visual` | Visual Customization | Fonts, UI tweaks, colors |
-| `custom-assets` | Custom Assets | Icons, banners, avatars |
-| `plugins` | Plugin Settings | Per-plugin configuration |
-| `tft` | TFT Settings | TFT-specific toggles |
-| `backup` | Backup & Restore | Cloud backup settings |
-| `deprecated` | Deprecated | Unused settings |
-
-New categories can be added to the `categories` object in `settings-meta.json`.
+When adding a new key to `datastoreDefault.js`:
 
-## ESLint Enforcement
+1. Add its category, description, and type to `docs/settings-meta.json`.
+2. If it should appear in the wiki, add it to a group in `docs/wiki-content.json`.
+3. Run `pnpm run wiki:check`.
+4. Run `pnpm run wiki:generate` and review the generated files in `wiki/`.
 
-The ESLint config (`eslint.config.js`) enforces documentation rules:
+## Categories
 
-- **Current level**: `warn` — shows warnings but doesn't block commits
-- **To enforce strictly**: Change `warn` → `error` in `eslint.config.js` for `jsdoc/require-jsdoc` and `jsdoc/require-description`
-
-## Git Hooks
-
-- **Pre-commit**: Runs ESLint on staged files via `lint-staged`
-- **Pre-push**: Runs full lint + wiki validation (`--check` mode)
-
-## Wiki Generation
+| Key | Name | Used for |
+|-----|------|----------|
+| `theme-core` | Core Theme | Basic theme behavior, version, language, update notices. |
+| `wallpaper-audio` | Wallpaper & Audio | Backgrounds, audio playback, slideshow, window effects. |
+| `theme-visual` | Visual Customization | Fonts, UI tweaks, colors, layout visibility. |
+| `custom-assets` | Custom Assets | Icons, banners, avatars, and visual replacements. |
+| `plugins` | Plugin Settings | Optional plugin behavior and plugin configuration. |
+| `tft` | TFT Settings | TFT-specific toggles. |
+| `backup` | Backup & Restore | Manual and cloud backup settings. |
+| `deprecated` | Deprecated | Settings no longer in active use. |
+| `internal` | Internal | Values not meant to be shown to normal users. |
+
+## Validation
 
 ```bash
-# Generate wiki locally
-pnpm run wiki:generate
-
-# Check documentation coverage (no file writes)
 pnpm run wiki:check
+pnpm run wiki:generate
 ```
 
-The GitHub Action (`.github/workflows/generate-wiki.yml`) runs on push to `main` and auto-publishes to the repo wiki.
+`wiki:check` validates that referenced settings are documented and that required pages are present. Warnings are informational; errors fail the check.
+
+## Publishing
+
+The GitHub Action at `.github/workflows/generate-wiki.yml` runs the generator and pushes generated Markdown files to the repository wiki. It replaces old generated Markdown pages so removed or renamed pages do not remain in the wiki.

docs/settings-meta.json

@@ -40,6 +40,11 @@
             "description": "Master toggle to enable or disable all Elaina Theme plugins.",
             "type": "boolean"
         },
+        "Theme-language": {
+            "category": "theme-core",
+            "description": "Theme UI language. Use client to follow the League Client language.",
+            "type": "string"
+        },
         "Theme-version": {
             "category": "theme-core",
             "description": "Current installed theme version (managed automatically).",
@@ -160,6 +165,46 @@
             "description": "Time between wallpaper changes in slideshow mode (milliseconds).",
             "type": "number"
         },
+        "WallpaperAudio-timeUpdate": {
+            "category": "wallpaper-audio",
+            "description": "Interval for saving wallpaper/audio playback progress to ElainaData (milliseconds).",
+            "type": "number"
+        },
+        "Playback-speed": {
+            "category": "wallpaper-audio",
+            "description": "Wallpaper video playback speed as a percentage.",
+            "type": "number"
+        },
+        "disable-theme-wallpaper": {
+            "category": "wallpaper-audio",
+            "description": "Completely disable the theme wallpaper background.",
+            "type": "boolean"
+        },
+        "window-effect-name": {
+            "category": "wallpaper-audio",
+            "description": "Window background effect mode such as transparent, acrylic, mica, or vibrancy.",
+            "type": "string"
+        },
+        "window-effect-color-base": {
+            "category": "wallpaper-audio",
+            "description": "Base color used by the selected window effect before alpha is applied.",
+            "type": "string"
+        },
+        "window-effect-alpha": {
+            "category": "wallpaper-audio",
+            "description": "Alpha component appended to the window effect color.",
+            "type": "string"
+        },
+        "window-effect-color": {
+            "category": "wallpaper-audio",
+            "description": "Computed window effect color including alpha.",
+            "type": "string"
+        },
+        "window-effect-material": {
+            "category": "wallpaper-audio",
+            "description": "Material variant used by window effects that support material selection.",
+            "type": "string"
+        },
         "turnoff-audio-ingame": {
             "category": "wallpaper-audio",
             "description": "Automatically mute theme audio when in a game.",
@@ -415,6 +460,31 @@
             "description": "Hide the theme usage time counter in settings.",
             "type": "boolean"
         },
+        "hide-summoner-rift-5v5": {
+            "category": "theme-visual",
+            "description": "Hide the Summoner's Rift 5v5 tab or section in the play page.",
+            "type": "boolean"
+        },
+        "hide-aram": {
+            "category": "theme-visual",
+            "description": "Hide the ARAM tab or section in the play page.",
+            "type": "boolean"
+        },
+        "hide-arena": {
+            "category": "theme-visual",
+            "description": "Hide the Arena tab or section in the play page.",
+            "type": "boolean"
+        },
+        "hide-custom-game-section": {
+            "category": "theme-visual",
+            "description": "Hide the custom game section in the play page.",
+            "type": "boolean"
+        },
+        "hide-tft": {
+            "category": "tft",
+            "description": "Hide the TFT tab or section in the play page.",
+            "type": "boolean"
+        },
         "hide-tft-match-history": {
             "category": "tft",
             "description": "Hide TFT match history section.",
@@ -470,6 +540,11 @@
             "description": "Show the auto-accept toggle button in the lobby.",
             "type": "boolean"
         },
+        "auto_accept_delay": {
+            "category": "plugins",
+            "description": "Delay before auto-accepting a ready check (milliseconds).",
+            "type": "number"
+        },
         "dodge-button": {
             "category": "plugins",
             "description": "Show a dodge button in champion select to leave the queue.",
@@ -716,4 +791,4 @@
             "hidden": true
         }
     }
-}
+}