Skip to content

Prepare Jot source for public use - #2

Merged
froppa-agent merged 2 commits into
mainfrom
cleanup/public-project-docs-20261022
Oct 22, 2026
Merged

froppa-agent merged 2 commits into
mainfrom
cleanup/public-project-docs-20261022

Conversation

@froppa-agent

@froppa-agent froppa-agent commented Oct 22, 2026 •

Copy link
Copy Markdown
Collaborator

Context

Prepare Jot's source for public use with clear licensing and documentation that matches the current app.

Summary

Jot now has an MIT license and a shorter README describing its local-only behavior and current limits, plus a screenshot with sample notes. Repository visibility stays private.

Changes

  • Add the MIT license.
  • Document category-scoped search, pinning, inline Markdown and build/run commands.
  • Remove the unimplemented reminder claim and iCloud setup recipe; state the lack of sync, export and backup.
  • Ignore local SwiftPM state.
  • Add a screenshot containing only sample notes.

Validation

  • Checked Markdown links, feature claims, license text and diff whitespace.
  • Gitleaks found no secrets across six historical non-merge commits. A text scan across eight reachable commits found no local paths, private-key/token patterns or email addresses in file contents; author metadata and binary assets were excluded.
  • Local Swift tests: 3 passed. The release build completed and produced Jot.app; its executable, Info.plist and icon were checked.
  • The compiler warned about an unhandled throwing task in the existing reminder scheduler, which is not exposed by the UI.
  • Previous documentation-commit CI passed; checks for the screenshot commit are asynchronous.
  • UI walkthrough passed: capture, edit, inline Markdown, category changes, pinning, category-scoped search, and persistence across a confirmed quit/relaunch. The temporary test build used a separate SwiftData store; no personal notes were used.
  • No UI or runtime code changed. No installation, visibility change or release publication.

@froppa-agent
froppa-agent merged commit 30e0fd7 into main Oct 22, 2026
2 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