docs: polish OSS project surfaces - #13
Merged
Merged
Conversation
harshmathurx
enabled auto-merge (squash)
August 6, 2026 07:55
harshmathurx
disabled auto-merge
August 6, 2026 07:55
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
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
Refreshes OpenNotes' public OSS surfaces so new users and contributors can understand the project faster: status, install caveats, data model, contribution paths, architecture, support, governance, and release process.
Why
The repo already had the right OSS basics, but the entry points were uneven. The README mixed product pitch, download notes, and contributor guidance without a clear maintainer map, and the changelog/release docs had drifted from the current release state.
Changes
docs/architecture.mdfor contributors changing the app shell, core services, extensions, or Tauri bridge.SUPPORT.mdandGOVERNANCE.md.CONTRIBUTING.mdwith project orientation and extension contribution guidance.SECURITY.mdaround local-first risks, bridge scope, and private disclosure.CHANGELOG.mdforv0.1.1,v0.1.2, and the current unreleased docs pass.Validation
pnpm exec prettier --check README.md CONTRIBUTING.md SECURITY.md RELEASE.md CHANGELOG.md docs/README.md docs/architecture.md docs/plan.md GOVERNANCE.md SUPPORT.md .github/ISSUE_TEMPLATE/config.ymlgit diff --checkpnpm run lintpnpm run typecheckpnpm exec vitest run(24 files, 386 tests)pnpm run buildRelease note