Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Move content from VS Code extension README into the main docs site #2833

Draft
wants to merge 9 commits into
base: main
Choose a base branch
from

Conversation

andyw8
Copy link
Contributor

@andyw8 andyw8 commented Nov 6, 2024

Let's unify the documentation. I cleaned up a little redundancy (see commits) but there may be more work to do to remove overlap or inconsistencies.

@andyw8 andyw8 added documentation Improvements or additions to documentation chore Chore task vscode This pull request should be included in the VS Code extension's release notes labels Nov 6, 2024
@@ -1,478 +1,3 @@
# Ruby LSP
# Ruby LSP – VS Code extension
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We'll need to keep some of this content for the Extensions Marketplace but I think we can cut it down substantially.

information to provide suggestions of how to design the application. For example,

```
@ruby /design I'm working on a web application for schools.
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

(had to split this over two lines for better formatting)

@andyw8 andyw8 force-pushed the andyw/move-vscode-readme-into-docs branch from 92a2b71 to b8e5554 Compare November 28, 2024 18:58
@andyw8 andyw8 marked this pull request as ready for review November 28, 2024 19:01
@andyw8 andyw8 requested a review from a team as a code owner November 28, 2024 19:01
@andyw8
Copy link
Contributor Author

andyw8 commented Nov 28, 2024

(fixing the unintentional Prism changes)

@andyw8 andyw8 marked this pull request as draft November 28, 2024 21:07
@andyw8
Copy link
Contributor Author

andyw8 commented Nov 28, 2024

TODO: restore the original README since it's needed for the VS Code extension marketplace

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
chore Chore task documentation Improvements or additions to documentation vscode This pull request should be included in the VS Code extension's release notes
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant