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

docs: Copilot improvements #3455

Merged
merged 18 commits into from
Jul 12, 2024
Merged

docs: Copilot improvements #3455

merged 18 commits into from
Jul 12, 2024

Conversation

MarcinVaadin
Copy link
Member

Fixes #1573

@MarcinVaadin MarcinVaadin requested a review from emarc May 23, 2024 13:59
@github-actions github-actions bot added the Language unchecked English language check has not been done label May 23, 2024
@MarcinVaadin MarcinVaadin marked this pull request as draft May 23, 2024 14:43
@MarcinVaadin MarcinVaadin marked this pull request as ready for review May 24, 2024 07:05

To get the best Copilot experience use the Vaadin plugin for link:https://plugins.jetbrains.com/plugin/23758-vaadin[IntelliJ] or link:https://marketplace.visualstudio.com/items?itemName=vaadin.vaadin-vscode[Visual Studio Code]. It improves saving changes you made into your files, enables seamless Undo integration (IntelliJ only) and more!
Copy link
Member

Choose a reason for hiding this comment

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

What does and more refer to? This isn't a marketing page, where we should build up “hype”. Stick to what we know our products do and don't do, and don't leave readers guessing. Also, avoid getting excited in documentation (avoid exclamation marks).

I don't fully understand what improves saving changes you made into your files means. What does “saving changes you made into your files” mean more concretely, and how does Copilot improve that?

Suggested change
To get the best Copilot experience use the Vaadin plugin for link:https://plugins.jetbrains.com/plugin/23758-vaadin[IntelliJ] or link:https://marketplace.visualstudio.com/items?itemName=vaadin.vaadin-vscode[Visual Studio Code]. It improves saving changes you made into your files, enables seamless Undo integration (IntelliJ only) and more!
To get the best Copilot experience, use the Vaadin plugin for link:https://plugins.jetbrains.com/plugin/23758-vaadin[IntelliJ] or link:https://marketplace.visualstudio.com/items?itemName=vaadin.vaadin-vscode[Visual Studio Code]. The plugin improves saving changes you made into your files and integrates with the undo-functionality (IntelliJ only).

Copy link
Member Author

Choose a reason for hiding this comment

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

improves saving changes you made into your files

It was suppose to mean that if you use plugin, IDE document is automatically refreshed. Without it user must rely on IDE's file system watcher and sometimes changes might be unnoticed.

Copy link
Member

Choose a reason for hiding this comment

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

Right, so when I edit a view with Copilot, the plugin makes sure the source code file, if opened in the IDE, shows the updated code as well. I think we should explain it like that instead.

Copy link
Member Author

Choose a reason for hiding this comment

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

Yes, exactly

articles/tools/copilot/index.adoc Outdated Show resolved Hide resolved
articles/tools/copilot/index.adoc Outdated Show resolved Hide resolved
jouni and others added 2 commits May 30, 2024 14:30
@jouni jouni changed the base branch from next to latest June 17, 2024 13:40
@russelljtdyer russelljtdyer removed the Language unchecked English language check has not been done label Jul 12, 2024
@russelljtdyer russelljtdyer added the Language checked English language check done label Jul 12, 2024
Copy link
Collaborator

@russelljtdyer russelljtdyer left a comment

Choose a reason for hiding this comment

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

Looks good.

@russelljtdyer russelljtdyer merged commit 35537a9 into latest Jul 12, 2024
3 checks passed
@russelljtdyer russelljtdyer deleted the docs/copilot-update branch July 12, 2024 08:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Language checked English language check done
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants