README

Sucrose Wiki — Publishing Guide (Maintainer Only)

This file is NOT a wiki page. It is an internal guide for the maintainer who publishes the contents of this folder to the Sucrose GitHub Wiki. Do NOT copy README.md into the wiki clone — copy every other .md file.

This folder holds the source Markdown for the Sucrose GitHub Wiki. GitHub serves a repository's wiki from a separate Git repository (<repo>.wiki.git), so publishing is a copy-and-push operation, not a normal repo commit.

Status: the wiki is already live at https://github.com/Taiizor/Sucrose/wiki. Use the steps below to push future updates.

---

How to publish (updates)

1. Clone the wiki repository (note the .wiki.git suffix — it is a different repo from the code):

   git clone https://github.com/Taiizor/Sucrose.wiki.git

2. Copy every .md from this folder into the clone, EXCEPT this README.md.

   PowerShell:

   $src = "E:\MyProject\Sucrose\Pro\Wiki"
   $dst = "<path-to>\Sucrose.wiki"
   Get-ChildItem -Path $src -Filter *.md |
       Where-Object { $_.Name -ne 'README.md' } |
       Copy-Item -Destination $dst -Force

3. Commit and push:

   cd <path-to>/Sucrose.wiki
   git add -A
   git commit -m "Update Sucrose wiki"
   git push origin master   # the wiki default branch is usually 'master'

   The pages go live immediately on the repository's Wiki tab.

GitHub-wiki special files

Three files are treated specially by GitHub Wikis — keep their exact names:

File	Role
Home.md	The wiki landing page (the tab's default page).
_Sidebar.md	Renders as the navigation sidebar on every page.
_Footer.md	Renders as the footer on every page.

All other *.md files become pages named after the file (e.g. Type-Web.md → the Type-Web page). Internal links use the page name without the extension, e.g. [Type-Web](Type-Web).

Counts. This folder contains 91 .md files. Excluding this README.md, 90 files publish: the 3 GitHub-wiki special files (Home.md, _Sidebar.md, _Footer.md) plus 87 content pages.

---

Diagrams — done (native Mermaid)

All 26 architecture/flow diagrams are embedded directly in the pages as native Mermaid code blocks, which GitHub Wiki renders automatically. No diagram images need to be produced. They live in: Architecture-Overview, Lifecycle, Command-Reference, IPC, Backgroundog-Service (×2), Crash-Reporting, Update-Internals, Undo-Internals, Performance-Rules, Wallpaper-Types, Choosing-Engines, Engines-Overview, Engine-Comparison, Type-Web, Type-Application, Create-Overview, Create-Package-Format, Create-Web-Architecture, Settings-Persistence, Extending-Sucrose, Repository-Layout, Shared-Item-Projects, Publish-Pipeline, Bundle-Installer-Internals, Troubleshooting-Settings-Startup-GPU.

To tweak a diagram, just edit its ```mermaid block in the page.

---

Screenshot checklist (the only assets still needed)

32 screenshot placeholders remain across 28 pages, each marked with a > 📷 **Screenshot needed:** blockquote. Capture each one, add the image to the wiki, and replace the placeholder blockquote with the image. Grouped by page:

✅ Added so far: the 6 Settings pages (General, Personal, Performance, Wallpaper, System, Other), the Setting-folder screenshot on Settings-Overview, the Undo-Internals and Uninstalling-Sucrose screenshots, both Discord-Rich-Presence screenshots, and all 3 Theme-Tray-Startup screenshots.

Automation-Examples.md

• Sucrose.Commandog.exe console output after running ✔Test✖true✖42✖hello, showing the Test Values: line and the three parsed values.

Backup-Restore-Reset.md

• Portal → Settings → System page showing the Export / Import / Reset buttons and the clear-cache/store/log actions with their live size hints.

Cache-Management.md

• Portal → Settings → System showing the Clear Cache / Clear Store actions with their live size hints.

Choosing-Engines.md

• Portal → Settings → Wallpaper page showing the per-type engine selector ComboBoxes (Gif/Video/Url/Web/YouTube/Application Player).

Crash-Reporting.md

• The Watchdog crash dialog (dark theme) showing the exception message and the log/source/help fields.

Create-Customization-Controls.md

• The Portal "Customize" panel for a Web wallpaper showing a slider, a dropdown, a color picker, and a checkbox grouped under section labels.

Create-Example-Wallpapers.md

• The Portal Library showing the shipped Showcase wallpapers (Neo Matrix, Fluid Simulation, Simple System, Music Tunnel, Living Room, Ray Music Visualizer).

Create-Overview.md

• A wallpaper folder open in File Explorer showing SucroseInfo.json, SucroseProperties.json, an HTML source file, and thumbnail/preview images.

Create-Step-By-Step.md

• The Portal "Create Theme" dialog showing the Title/Description/Author/Contact fields, tag chips, thumbnail/preview pickers, and the type-specific Source input.

Customizing-Wallpaper.md

• The Customize / Property editor window for a video wallpaper (MpvPlayer panel).
• The Customize / Property editor window for a web/browser wallpaper showing the filter sliders.

Data-Locations.md

• Windows File Explorer at %AppData%\Sucrose with the Setting, Log, Cache, Library, and Showcase folders expanded one level.

Engine-Aurora.md

• An Application wallpaper running via Aurora across two monitors (e.g. a game or screensaver embedded behind the desktop icons).

Engines-Overview.md

• Portal → Settings → Wallpaper page showing the per-type engine selectors (GifPlayer / VideoPlayer / UrlPlayer / WebPlayer / YouTubePlayer / ApplicationPlayer).

Getting-Help.md

• Portal → About dialog showing the version, framework, and architecture fields to include in a bug report.

Installation.md

• The Sucrose listing on the Microsoft Store (apps.microsoft.com) showing the Get/Install button.
• The GitHub Releases asset table for the latest Sucrose tag, showing the three per-architecture .exe files.

Logs-Diagnostics.md

• Portal → Settings → System showing the log create/delete action used to produce the compressed log bundle.

Managing-Library.md

• Portal → Library page showing a grid of installed wallpaper cards.
• LibraryCard right-click context menu open over a wallpaper.

Multi-Monitor.md

• The Display Preferences dialog showing the Screen/Expand/Duplicate radio group and the clickable monitor tiles.

Portal-Interface-Tour.md

• The Portal main window with the top navigation bar and toolbar, a populated Library, and the bottom status bar visible.

Property-Service.md

• The Property (Customize) window showing a mix of slider, dropdown, checkbox, and color-picker controls for a wallpaper.

Quick-Start.md

• The Portal main window on the Library page right after first launch, showing the auto-imported Showcase wallpapers.

Troubleshooting-Common.md

• Portal → Settings → Wallpaper page showing the per-type engine selectors (used to switch engines while troubleshooting).

Type-Gif.md

• The Customize panel for a GIF wallpaper showing the MpvPlayer property sliders.

Type-Url.md

• A URL wallpaper showing a live external page on the desktop.

Type-Video.md

• The Customize panel for a Video wallpaper rendered by MpvPlayer.

Type-YouTube.md

• The Customize panel for a YouTube wallpaper showing the caption and playbackRate controls.

Using-Store.md

• Portal → Store page (FullStorePage) with the category navigation on the left and a grid of wallpaper cards.
• A StoreCard mid-download showing the progress ring.

Wallpaper-Cycling.md

• The Wallpaper Cycling dialog showing the active toggle, transition-time number box, transition-type dropdown, and the reset-exclusion button.

Inline previews. Home.md and the Type-* pages reference existing repo images (the Preview.png / per-type *.gif previews). Relative repo paths do not resolve on the GitHub Wiki — upload those images to the wiki or use absolute raw URLs (https://raw.githubusercontent.com/Taiizor/Sucrose/develop/.screenshots/<file>).

---

Research source note

These pages were generated from the research documents in docs/wiki-research/. Those research files are an internal working source and can be deleted after the wiki is finalized.