Skip to content

Commit 6849729

Browse files
committed
Doc: update AGENTS.md with details of auto-update functionality.
1 parent 5598b14 commit 6849729

1 file changed

Lines changed: 22 additions & 0 deletions

File tree

Doc/AGENTS.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -92,6 +92,9 @@ MVP plan.
9292

9393
- `ErrorPage.swift` — Error-page HTML generator (renders Markdown via MudCore)
9494

95+
- `CheckForUpdatesView.swift` — SparkleController (static updater owner),
96+
CheckForUpdatesViewModel (KVO observer), and menu button (`#if SPARKLE`)
97+
9598
**App/CLI/ key files:**
9699

97100
- `main.swift``mud` CLI: argument parsing, rendering via MudCore, stdout and
@@ -122,6 +125,9 @@ MVP plan.
122125

123126
- `CommandLineSettingsView.swift` — Command Line settings pane
124127

128+
- `UpdateSettingsView.swift` — Updates pane: auto-update radio group, Check
129+
Now, release notes link (`#if SPARKLE`)
130+
125131
- `DebuggingSettingsView.swift` — Debugging pane (debug builds only; reset
126132
preferences)
127133

@@ -163,6 +169,22 @@ MVP plan.
163169
- `Doc/Guides/command-line.md` — Bundled guide: CLI usage for App Store and
164170
direct distribution builds
165171

172+
**Scripts and CI:**
173+
174+
- `.github/scripts/update-sparkle` — Download Sparkle framework and CLI tools
175+
to `Vendor/Sparkle/`
176+
- `.github/scripts/build-appcast` — Sign DMG and generate single-item
177+
`appcast.xml`
178+
- `.github/scripts/build-release-notes` — Ruby script: extract per-version
179+
sections from `Doc/RELEASES.md` and render HTML via Mud CLI
180+
181+
**Doc:**
182+
183+
- `Doc/RELEASES.md` — User-facing release notes (hand-written, per-version
184+
sections)
185+
- `Site/releases/` — Pre-rendered release notes HTML (generated by
186+
`build-release-notes`)
187+
166188
**Important** — Make sure to update this section of `Doc/AGENTS.md` if you add
167189
or remove key files.
168190

0 commit comments

Comments
 (0)