docs: refresh README + DEVELOPER for v0.1.8 reality; wiki built out in parallel#18
Merged
Merged
Conversation
README.md: - Fix the stale download link example (was AOS_Mail_0.1.0_..., now points at "latest") - Add a "Need help?" section linking to the new wiki, with a one-line fix for the most common issue (notifications via tccutil reset) DEVELOPER.md: - Bundle size line: was "9 MB DMG / 43 MB unpacked" pre-Node-bundling; now 45 MB DMG / 125 MB unpacked, dominated by the bundled Node binary (knowingly). - Replace the entire manual release section with the automated GitHub Actions flow (release.yml). The old steps documented running codesign/notarytool/stapler/gh release create locally; none of that is true anymore — tauri-action handles all of it. - Add the full 8-secret matrix (APPLE_CERTIFICATE through TAURI_SIGNING_PRIVATE_KEY_PASSWORD) with how-to-obtain commands. - Updater key: v1 → v2. Document that v1's password was lost (incident in POST-MORTEM-2026-05.md), explain rotation cost (every install on old pubkey loses auto-update once). - Add a Troubleshooting section covering the bugs we hit during the v0.1.8 release campaign: SIGKILL on unsigned bundled node, keychain import failures, notarization team-ID errors, stale tauri-bundler cache, AppleDouble metadata in updater tarball, secret-key not forwarded mid-session, OpenRouter free-tier rate limits. Wiki was built out in parallel — see github.com/mrdulasolutions/AOS-Mail/wiki. The wiki holds operational guides (install, troubleshooting, release); DEVELOPER.md remains the canonical technical reference. Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
User request: "update the readme and developer Md files in github... AFTER that, i need you to build out a complete wiki." Done both.
README.md (light touch)
DEVELOPER.md (major surgery on the release section)
Wiki — built out in parallel
Pushed in a separate commit to the wiki repo. 11 pages, ~80 KB of content:
User-facing:
Developer-facing:
Plus a sidebar (rendered on every wiki page) for navigation.
The wiki holds operational guides — install, troubleshooting, release procedures. The in-repo `DEVELOPER.md` + `docs/` remain the canonical technical reference. All wiki pages cross-link back to the in-repo docs for depth, so the wiki stays the satellite, not a duplicate.
🤖 Generated with Claude Code