docs: comprehensive OSS documentation, screenshots, and binary rename to notey#5
Merged
Merged
Conversation
…iewed via bmad-auto
…ng-overlay into main (bmad-auto)
…viewed via bmad-auto
…on-guidance into main (bmad-auto)
…iewed via bmad-auto
…onboarding into main (bmad-auto)
… main (bmad-auto)
…nd reviewed via bmad-auto
…wayland-fallback into main (bmad-auto)
… into main (bmad-auto)
…ication into main (bmad-auto)
…nary to notey Curate professional open-source documentation and clean up placeholder project identity ahead of release. Documentation: - Rewrite README with features, screenshot gallery, install, dev setup - Add CHANGELOG (0.1.0), ROADMAP, CONTRIBUTING, SECURITY, CODE_OF_CONDUCT, LICENSE (MIT), and .github issue/PR templates - Add docs/ guides: installation, user-guide, keyboard-shortcuts, configuration, cli, architecture Screenshots: - New e2e/screenshots.mjs captures every view (light + dark) into docs/images via tauri-driver; add takeScreenshot primitive and `npm run screenshots` - Grant core:window:allow-show / set-focus so the capture window can be shown for screenshotting (symmetric with existing allow-dismiss-window) Metadata + binary rename (tauri-app -> notey): - Cargo crate + lib (notey_lib), main.rs, tauri.conf.json (productName "Notey", identifier com.pinkyd.notey), package.json, e2e APP_PATH, and integration tests - Fill in author (Paul Bean <pinkyd@luckytick.net>), license, repository Verified: cargo test, npm test (628), and npm run build all pass. Co-Authored-By: Claude Opus 4.8 <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
Curates a professional open-source documentation set for Notey, adds automated screenshot capture, and cleans up the placeholder project identity (binary/crate/product renamed
tauri-app→notey).Documentation
.github/issue templates (bug/feature/config) + PR templatedocs/guides: installation, user-guide, keyboard-shortcuts, configuration, cli, architectureScreenshots
e2e/screenshots.mjsdrives the real app via tauri-driver and captures all 10 views (light + dark) intodocs/images/; adds atakeScreenshotprimitive andnpm run screenshotscore:window:allow-show/core:window:allow-set-focusincapabilities/default.jsonso the (hidden-on-launch) capture window can be shown for screenshotting — symmetric with the existingallow-dismiss-window. Please review this capability change.Metadata + binary rename (
tauri-app→notey)Cargo.tomlcrate + lib (notey_lib),main.rs,tauri.conf.json(productName: Notey, identifiercom.pinkyd.notey),package.json,e2e/run.mjsAPP_PATH, and all integration testsPaul Bean <pinkyd@luckytick.net>), license, repositoryVerification
cargo test— pass (0 failures)npm test— 628 tests / 45 files passnpm run build— cleantauri-app/tauri_app_libreferences; renamed binary builds and launches under tauri-driver🤖 Generated with Claude Code