docs: update project details #22
Conversation
There was a problem hiding this comment.
Pull request overview
This PR updates project documentation and descriptions to clarify features and improve consistency. The changes refine language across configuration files and the README to better reflect current functionality.
- Updated feature descriptions to explicitly mention "spelling errors" correction
- Reorganized README sections to improve clarity and flow
- Simplified browser support documentation by removing specific channel references
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| static/cws/cws.json | Updated singlePurpose description to explicitly mention fixing spelling errors |
| package.json | Changed displayName punctuation from en dash to hyphen |
| README.md | Enhanced feature descriptions, reorganized development commands, updated browser requirements, and clarified implementation details |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| { | ||
| "name": "Proofly", | ||
| "displayName": "Proofly – Private AI Writing, Proofreading & Grammar Assistant", | ||
| "displayName": "Proofly - Private AI Writing, Proofreading & Grammar Assistant", |
There was a problem hiding this comment.
The displayName was changed from using an en dash (–) to a hyphen (-). However, the store listing in static/cws/cws.json still uses the en dash format ("Proofly – Private AI Writing..."). For consistency, both should use the same punctuation mark.
README.md
Outdated
| 2. **Fork & Branch**: Create a feature branch from `main` | ||
| 3. **Make Changes**: Follow our coding standards and conventions | ||
| 4. **Test Thoroughly**: Verify your changes work as expected | ||
| 4. **Test Thoroughly**: Verify your changes work as expected though automated e2e tests |
There was a problem hiding this comment.
Typo: "though" should be "through"
| 4. **Test Thoroughly**: Verify your changes work as expected though automated e2e tests | |
| 4. **Test Thoroughly**: Verify your changes work as expected through automated e2e tests |
No description provided.