Skip to content

docs: improve onboarding and clarify fixture safety - #126

Merged
RasputinKaiser merged 1 commit into
mainfrom
docs/onboarding-and-fixture-safety-2026-10-05
Oct 6, 2026
Merged

RasputinKaiser merged 1 commit into
mainfrom
docs/onboarding-and-fixture-safety-2026-10-05

Conversation

@RasputinKaiser

Copy link
Copy Markdown
Owner

Summary

  • Add README navigation, a first-scan walkthrough, clone-to-launch steps, platform requirements, and source-grounded troubleshooting.
  • Correct the support link that referenced a missing issue template.
  • Clarify that Trash rollback is attempted and can fail, and distinguish the executable launch fallback from successful packaged-app launch.
  • Add focused contributor workflow guidance and document build-helper process/bundle side effects.
  • Warn that fixture mode recursively deletes and recreates its configured fixture root, and uses real macOS Trash operations; document the existing redaction flag.

Scope

Only README.md and CONTRIBUTING.md change. Existing release, screenshot, licensing, privacy, and maintainer notarization content is preserved. No application code, dependencies, workflows, release assets, settings, or Git tags changed.

Verification

  • Read Package.swift, build/fixture helpers, upload audit, workflows, WelcomeView, TrashConfirmationSheet, FileActionService, TransactionalTrashMover, scanner source, and FilterStore against current main.
  • Verified the v0.8.0 DMG/checksum assets exist and the commercial_support.yml issue template does not exist.
  • Passed static checks for 23 local Markdown paths/anchors, 11 shell example syntax checks (bash -n), and no trailing whitespace.
  • Re-read main immediately before committing and verified the resulting tree changes only the two documentation files.
  • Not run: swift build/test, app launch, fixture actions, or the full public upload audit. The editing host is Linux without Swift or macOS tools. CI results should be reviewed separately; these changes make no new runtime-test pass claims.

@RasputinKaiser
RasputinKaiser marked this pull request as ready for review October 6, 2026 00:10
@RasputinKaiser
RasputinKaiser merged commit 89181f7 into main Oct 6, 2026
6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant