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: add blog post introducing tabby inline edit functionality #2903

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

zwpaper
Copy link
Member

@zwpaper zwpaper commented Aug 18, 2024

No description provided.

@zwpaper
Copy link
Member Author

zwpaper commented Aug 18, 2024

cc @gyxlucy

@wsxiaoys wsxiaoys requested a review from gyxlucy August 19, 2024 05:46

Tabby Edit is a feature that allows you to edit your code directly in your favorite editor.

Tabby Edit will not change your code directly,
Copy link
Member

@gyxlucy gyxlucy Aug 21, 2024

Choose a reason for hiding this comment

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

The key of this feature is to offer a new user interaction - to enable users to instruct LLM with natural language for code changes on a specific piece of code snippet (unlike code completion or chat interface). Would be good to highlight this aspect a bit in the intro section.

Then you can type your prompt to describe what you want to do,
and Tabby will generate the code for you showing the difference between your code and the generated ones.

![Tabby Edit](./tabby-edit.png)
Copy link
Member

Choose a reason for hiding this comment

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

This image is confusing to me. Maybe a GIF to showcase the full experience as you are describing - select code, command palette, prompt, choose Accept or Discard

Copy link
Member Author

Choose a reason for hiding this comment

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

This image only served as a header image, GIFs are appended later in the blog, should we also post a GIF here?


## What can you do with Tabby Edit

With the power of LLM, Tabby Edit can help you to do many things,
Copy link
Member

Choose a reason for hiding this comment

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

Maybe highlight that the feature can help with many mundane tasks and help achieve better productivity in daily work.

Copy link
Member

@gyxlucy gyxlucy left a comment

Choose a reason for hiding this comment

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

The GIFs look great! Very helpful to demonstrate the feature.
Please address the comments mentioned :D Thanks!

@gyxlucy gyxlucy changed the title blog: add introduce tabby edit docs: add introduce tabby edit Aug 21, 2024
@wsxiaoys wsxiaoys changed the title docs: add introduce tabby edit docs: add blog post introducing tabby inline edit functionality Aug 21, 2024
@zwpaper zwpaper requested a review from gyxlucy September 6, 2024 11:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants