Skip to content
This repository has been archived by the owner on Oct 11, 2024. It is now read-only.

Commit

Permalink
docs: Adds recent screenshots to README & walkthrough (#21)
Browse files Browse the repository at this point in the history
* fix: Fixes command mapping

* docs: Updates README

* docs: Updates walkthrough images

* docs: Fixes formatting
  • Loading branch information
frgfm authored Dec 13, 2023
1 parent 0731d7e commit fee0aa8
Show file tree
Hide file tree
Showing 10 changed files with 25 additions and 21 deletions.
20 changes: 12 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,20 +51,26 @@
</a>
</p>

This extension guides you through your code contributions with Quack as a companion. The extension provides you with curated contribution guidelines from maintainers and assists you in meeting them.
![Compliance hint](media/compliance_hint.png)

This extension guides you through your code contributions with Quack as a companion. The extension provides curated contribution guidelines from maintainers and assists you in meeting them.

## Quick Tour

### Contribution guidance

Once installed, when you open a public GitHub project, the extension will activate like below:

![Companion sidebar](https://github.com/quack-ai/companion/blob/main/media/quack-sidebar.png)
![Guideline view](media/guideline_list.png)

You'll find two main sections (with ongoing development):
Once installed, when you open a public GitHub project, the extension will give you a new tab wher you'll find:

- **Contribution scoping**: everything for you to pick an issue/feature to work on, and ensure it's adequate to the project.
- **Guidelines**: automatic compliance of contribution guidelines, so that you can avoid the back-and-forth between the PR reviews and your IDE!
- **Code chat** (coming soon)

### Walthrough tutorial

![Developer walkthrough](media/dev_walkthrough.png)

With our walkthrough tutorial, you're only a few clicks away from having your own coding companion.

## Setup

Expand All @@ -74,8 +80,6 @@ Install [VSCode](https://code.visualstudio.com/Download)

### Install the extension

![Extension installation](https://github.com/quack-ai/companion/blob/main/media/extension-search.png)

Either:

- Follow the instructions on the online [VS Marketplace page](https://marketplace.visualstudio.com/items?itemName=quackai.quack-companion)
Expand Down
Binary file added media/compliance_hint.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added media/dev_walkthrough.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added media/editor_view.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed media/extension-search.png
Binary file not shown.
Binary file added media/github_auth.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added media/guideline_dashboard.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added media/guideline_list.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added media/marketplace_page.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
26 changes: 13 additions & 13 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -139,7 +139,7 @@
"viewsWelcome": [
{
"view": "quack-companion.authView",
"contents": "Welcome to Quack extension! Let's get you started\n[Authenticate](command:quack-companion.loginIn)",
"contents": "Welcome to Quack extension! Let's get you started\n[Authenticate](command:quack-companion.logIn)",
"when": "!quack-companion.hasQuackToken"
}
],
Expand Down Expand Up @@ -198,8 +198,8 @@
"title": "Sign-up using GitHub",
"description": "Go to Quack platform, click on **Login with GitHub** and follow the instructions.\n[Visit Quack platform](https://app.quackai.com/)",
"media": {
"image": "media/quack-logo.png",
"altText": "Quack logo"
"image": "media/github_auth.png",
"altText": "GitHub authentication"
},
"completionEvents": [
"onLink:https://app.quackai.com/"
Expand All @@ -210,8 +210,8 @@
"title": "Parse contribution guidelines from your repo",
"description": "Now select your repo, click on **Connect repo**, then on **Parse guidelines**.",
"media": {
"image": "media/quack-logo.png",
"altText": "Quack logo"
"image": "media/guideline_dashboard.png",
"altText": "Guideline management dashboard"
},
"completionEvents": []
},
Expand All @@ -220,8 +220,8 @@
"title": "Edit your guidelines",
"description": "Create guidelines or edit them by clicking on them.",
"media": {
"image": "media/quack-logo.png",
"altText": "Quack logo"
"image": "media/editor_view.png",
"altText": "Guideline edition view"
},
"completionEvents": []
},
Expand All @@ -230,7 +230,7 @@
"title": "Install the VSCode extension",
"description": "Go to VSCode marketplace and install Quack Companion.",
"media": {
"image": "media/quack-logo.png",
"image": "media/marketplace_page.png",
"altText": "Quack logo"
},
"completionEvents": [
Expand All @@ -242,7 +242,7 @@
"title": "Check the access for your contributors in VSCode",
"description": "Click on the Quack view, and authenticate. Your guidelines should be fetched automatically.\n[Authenticate](command:quack-companion.logIn)",
"media": {
"image": "media/quack-logo.png",
"image": "media/guideline_list.png",
"altText": "Quack logo"
},
"completionEvents": [
Expand Down Expand Up @@ -274,8 +274,8 @@
"title": "Authenticate using GitHub",
"description": "Click on **Authenticate** and follow the instructions.\n[Authenticate](command:quack-companion.logIn)",
"media": {
"image": "media/quack-logo.png",
"altText": "Quack logo"
"image": "media/github_auth.png",
"altText": "GitHub authentication"
},
"completionEvents": [
"onCommand:quack-companion.logIn"
Expand All @@ -296,8 +296,8 @@
"title": "Analyze code with Quack",
"description": "Select a code section and click on **Analyze code with Quack** (arrow symbol in your Quack tab)",
"media": {
"image": "media/quack-logo.png",
"altText": "Quack logo"
"image": "media/compliance_hint.png",
"altText": "Code compliance hint"
},
"completionEvents": [
"onCommand:quack-companion.analyzeCode",
Expand Down

0 comments on commit fee0aa8

Please sign in to comment.