Update README to remove beta reference and spelling errors#3274
Update README to remove beta reference and spelling errors#3274Trying-Two-Code wants to merge 3 commits into
Conversation
Similar to ChrisKaders concerns (the first two lines are heavily outdated). And some simple spelling fixes.
|
Do you want me to review this PR? Please comment |
|
/review |
|
PR Summary: Update README: remove LIVE SERVER++ (BETA) reference and fix typos/wording across documentation.
|
![pantoaibot[bot]](https://avatars.githubusercontent.com/in/934356?s=60&v=4){kind=small}
| @@ -1,5 +1,3 @@ | |||
| _[Wanna try [LIVE SERVER++](https://github.com/ritwickdey/vscode-live-server-plus-plus) (BETA) ? It'll enable live changes without saving file. https://github.com/ritwickdey/vscode-live-server-plus-plus ]_ | |||
|
|
|||
| # Live Server | |||
There was a problem hiding this comment.
[REFACTORING] You removed the top BETA promo link (LIVE SERVER++). Ensure you also search the repo (README, CHANGELOG, docs, issue templates, website, repo description) for any other references to vscode-live-server-plus-plus and update/remove them consistently. If removing the link could break external bookmarks, consider adding a brief note or redirect explaining it's deprecated or pointing to an alternative.
<!-- Optional short note near the top of README, if you want to help users coming from the old beta link -->
> Note: The previous **LIVE SERVER++ (BETA)** extension is no longer maintained. Please use **Live Server** (this extension) for an actively maintained experience.There was a problem hiding this comment.
There are no other mentions of this link.
|  | ||
|
|
||
| 4. Hit `(alt+L, alt+O)` to Open the Server and `(alt+L, alt+C)` to Stop the server (You can change the shortcut form keybinding). *[On MAC, `cmd+L, cmd+O` and `cmd+L, cmd+C`]* | ||
| 4. Hit `(alt+L, alt+O)` to Open the Server and `(alt+L, alt+C)` to Stop the server (You can change the shortcut from keybinding). *[On MAC, `cmd+L, cmd+O` and `cmd+L, cmd+C`]* |
There was a problem hiding this comment.
[NITPICK] Wording: "You can change the shortcut from keybinding" is slightly awkward. Consider replacing with a clearer phrasing such as: "You can change the shortcut in Keyboard Shortcuts / keybindings (Preferences → Open Keyboard Shortcuts)". Also prefer consistent platform naming (use "macOS" rather than "MAC").
4. Hit `(Alt+L, Alt+O)` to open the server and `(Alt+L, Alt+C)` to stop the server (you can change the shortcut in Keyboard Shortcuts / keybindings). *[On macOS, `Cmd+L, Cmd+O` and `Cmd+L, Cmd+C`]*There was a problem hiding this comment.
I have updated the wording.
|
Reviewed up to commit:7ec38a7eb2d358d4022ba98246d9f6c66ec7312e Additional SuggestionREADME.md, line:33Command Palette line was fixed for spelling — consider adding the macOS equivalent (Cmd+Shift+P) and standardizing shortcut casing across the README (e.g., use "Ctrl" vs "ctrl", "Alt" vs "alt") for consistency and readability.5. Open the Command Palette by pressing `F1`, `Ctrl+Shift+P` (Windows/Linux), or `Cmd+Shift+P` (macOS) and type `Live Server: Open With Live Server` to start a server or type `Live Server: Stop Live Server` to stop a server. |
Changed clunky wording to be clearer for viewers.
johnstonshawn991-art
left a comment
johnstonshawn991-art
left a comment
There was a problem hiding this comment.
If you're running incorporate
2 participants
Similar to ChrisKaders concerns (the first two lines are heavily outdated). And some simple spelling fixes.
PR Type
What kind of change does this PR introduce?
[ ] Bugfix [ ] Feature [ ] Refactoring (no functional changes, no api changes) [x] Documentation content changes [ ] Other: <!-- Please describe: -->What is the current behavior?
The README.md includes links directing users to a "Beta" repo that has not been updated in 7 years. The README.md also includes minor spelling errors.
Issue Number: N/A
What is the new behavior?
The README.md has been updated to remove the links to the "Beta" repo. The spelling errors have been corrected.
Does this PR introduce a breaking change?
Other information
Thanks to ChrissKaders for spotting the outdated link.