Improve repository documentation#16
Merged
Merged
Conversation
There was a problem hiding this comment.
Pull request overview
This PR upgrades the repository’s documentation to better communicate the product’s purpose, privacy posture, supported inputs, development workflow, and how releases are produced/distributed.
Changes:
- Replaces the minimal README with a branded header (logo, badges, preview image) and expanded onboarding/feature/privacy/architecture sections.
- Documents release distribution rationale (GitHub Releases vs GitHub Packages) and adds a dedicated release checklist/guide.
- Updates development validation docs to point to the consolidated
npm run checkflow.
Reviewed changes
Copilot reviewed 2 out of 3 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| README.md | Adds branded header and significantly expands user-facing docs (capabilities, privacy, onboarding, install, architecture, limitations, release rationale). |
| docs/RELEASING.md | Introduces a release checklist describing tagging, draft release workflow behavior, signing expectations, and semantic versioning. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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
Validation
The screenshot contains no imported account or personal data.