diff --git a/.github/labeler.yml b/.github/labeler.yml index c29c979..b9d116e 100644 --- a/.github/labeler.yml +++ b/.github/labeler.yml @@ -1,5 +1,5 @@ "ext: media": - - media/* + - assets/* "ext: styles": - styles/* diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 2dc424e..2c8227d 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -7,7 +7,7 @@ Whatever the way you wish to contribute to the project, please respect the [code ## Codebase structure - [`src/`](https://github.com/quack-ai/companion/blob/main/src/) - The actual platform codebase -- [`media/`](https://github.com/quack-ai/companion/blob/main/media/) - Binary assets +- [`assets/`](https://github.com/quack-ai/companion/blob/main/assets/) - Binary assets - [`styles/`](https://github.com/quack-ai/companion/blob/main/styles/) - Style sheet files - [`.vscode/`](https://github.com/quack-ai/companion/blob/main/.vscode/) - VSCode specific config - [`.github/`](https://github.com/quack-ai/companion/blob/main/.github/) - Configuration for GitHub workflow diff --git a/README.md b/README.md index 14d4b3f..7b653cf 100644 --- a/README.md +++ b/README.md @@ -55,7 +55,7 @@

-![Compliance hint](media/compliance_hint.png) +![Compliance hint](assets/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. @@ -63,7 +63,7 @@ This extension guides you through your code contributions with Quack as a compan ### Contribution guidance -![Guideline view](media/guideline_list.png) +![Guideline view](assets/guideline_list.png) Once installed, when you open a public GitHub project, the extension will give you a new tab wher you'll find: @@ -72,7 +72,7 @@ Once installed, when you open a public GitHub project, the extension will give y ### Walthrough tutorial -![Developer walkthrough](media/dev_walkthrough.png) +![Developer walkthrough](assets/dev_walkthrough.png) With our walkthrough tutorial, you're only a few clicks away from having your own coding companion. diff --git a/media/compliance_hint.png b/assets/compliance_hint.png similarity index 100% rename from media/compliance_hint.png rename to assets/compliance_hint.png diff --git a/media/dark/debug-rerun.svg b/assets/dark/debug-rerun.svg similarity index 100% rename from media/dark/debug-rerun.svg rename to assets/dark/debug-rerun.svg diff --git a/media/dark/error.svg b/assets/dark/error.svg similarity index 100% rename from media/dark/error.svg rename to assets/dark/error.svg diff --git a/media/dark/pass.svg b/assets/dark/pass.svg similarity index 100% rename from media/dark/pass.svg rename to assets/dark/pass.svg diff --git a/media/dark/quack.svg b/assets/dark/quack.svg similarity index 100% rename from media/dark/quack.svg rename to assets/dark/quack.svg diff --git a/media/dark/refresh.svg b/assets/dark/refresh.svg similarity index 100% rename from media/dark/refresh.svg rename to assets/dark/refresh.svg diff --git a/media/dev_walkthrough.png b/assets/dev_walkthrough.png similarity index 100% rename from media/dev_walkthrough.png rename to assets/dev_walkthrough.png diff --git a/media/editor_view.png b/assets/editor_view.png similarity index 100% rename from media/editor_view.png rename to assets/editor_view.png diff --git a/media/github_auth.png b/assets/github_auth.png similarity index 100% rename from media/github_auth.png rename to assets/github_auth.png diff --git a/media/guideline_dashboard.png b/assets/guideline_dashboard.png similarity index 100% rename from media/guideline_dashboard.png rename to assets/guideline_dashboard.png diff --git a/media/guideline_list.png b/assets/guideline_list.png similarity index 100% rename from media/guideline_list.png rename to assets/guideline_list.png diff --git a/media/light/debug-rerun.svg b/assets/light/debug-rerun.svg similarity index 100% rename from media/light/debug-rerun.svg rename to assets/light/debug-rerun.svg diff --git a/media/light/error.svg b/assets/light/error.svg similarity index 100% rename from media/light/error.svg rename to assets/light/error.svg diff --git a/media/light/pass.svg b/assets/light/pass.svg similarity index 100% rename from media/light/pass.svg rename to assets/light/pass.svg diff --git a/media/light/quack.svg b/assets/light/quack.svg similarity index 100% rename from media/light/quack.svg rename to assets/light/quack.svg diff --git a/media/light/refresh.svg b/assets/light/refresh.svg similarity index 100% rename from media/light/refresh.svg rename to assets/light/refresh.svg diff --git a/media/marketplace_page.png b/assets/marketplace_page.png similarity index 100% rename from media/marketplace_page.png rename to assets/marketplace_page.png diff --git a/media/quack-logo.png b/assets/quack-logo.png similarity index 100% rename from media/quack-logo.png rename to assets/quack-logo.png diff --git a/media/quack-sidebar.png b/assets/quack-sidebar.png similarity index 100% rename from media/quack-sidebar.png rename to assets/quack-sidebar.png diff --git a/media/quack-white.svg b/assets/quack-white.svg similarity index 100% rename from media/quack-white.svg rename to assets/quack-white.svg diff --git a/package.json b/package.json index f483e1b..d5d5459 100644 --- a/package.json +++ b/package.json @@ -76,16 +76,16 @@ "swift", "keybindings" ], - "icon": "media/quack-logo.png", + "icon": "assets/quack-logo.png", "repository": { "type": "git", "url": "https://github.com/quack-ai/companion" }, "bugs": { "url": "https://github.com/quack-ai/companion/issues", - "email": "support@quack-ai.com" + "email": "support@quackai.com" }, - "homepage": "https://quack-ai.com", + "homepage": "https://quackai.com", "type": "commonjs", "engines": { "vscode": "^1.74.0" @@ -124,7 +124,7 @@ { "id": "quack-companion", "title": "Quack Companion", - "icon": "media/dark/quack.svg" + "icon": "assets/dark/quack.svg" } ] }, @@ -134,7 +134,7 @@ "type": "tree", "id": "quack.authView", "name": "Authentication", - "icon": "media/dark/quack.svg", + "icon": "assets/dark/quack.svg", "contextualTitle": "Authentication", "when": "!quack.isAuthenticated" }, @@ -142,7 +142,7 @@ "type": "tree", "id": "quack.guidelineTreeView", "name": "Guidelines", - "icon": "media/dark/quack.svg", + "icon": "assets/dark/quack.svg", "contextualTitle": "Guidelines", "when": "quack.isAuthenticated" } @@ -174,8 +174,8 @@ "category": "Quack Companion", "title": "Fetch contribution guidelines", "icon": { - "light": "media/light/refresh.svg", - "dark": "media/dark/refresh.svg" + "light": "assets/light/refresh.svg", + "dark": "assets/dark/refresh.svg" } }, { @@ -183,8 +183,8 @@ "category": "Quack Companion", "title": "Check code against guideline", "icon": { - "light": "media/light/debug-rerun.svg", - "dark": "media/dark/debug-rerun.svg" + "light": "assets/light/debug-rerun.svg", + "dark": "assets/dark/debug-rerun.svg" } }, { @@ -192,8 +192,8 @@ "category": "Quack Companion", "title": "Check code against all repo guidelines", "icon": { - "light": "media/light/debug-rerun.svg", - "dark": "media/dark/debug-rerun.svg" + "light": "assets/light/debug-rerun.svg", + "dark": "assets/dark/debug-rerun.svg" } } ], @@ -259,7 +259,7 @@ "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/github_auth.png", + "image": "assets/github_auth.png", "altText": "GitHub authentication" }, "completionEvents": [ @@ -271,7 +271,7 @@ "title": "Parse contribution guidelines from your repo", "description": "Now select your repo, click on **Connect repo**, then on **Parse guidelines**.", "media": { - "image": "media/guideline_dashboard.png", + "image": "assets/guideline_dashboard.png", "altText": "Guideline management dashboard" }, "completionEvents": [] @@ -281,7 +281,7 @@ "title": "Edit your guidelines", "description": "Create guidelines or edit them by clicking on them.", "media": { - "image": "media/editor_view.png", + "image": "assets/editor_view.png", "altText": "Guideline edition view" }, "completionEvents": [] @@ -291,7 +291,7 @@ "title": "Install the VSCode extension", "description": "Go to VSCode marketplace and install Quack Companion.", "media": { - "image": "media/marketplace_page.png", + "image": "assets/marketplace_page.png", "altText": "Quack logo" }, "completionEvents": [ @@ -303,7 +303,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.login)", "media": { - "image": "media/guideline_list.png", + "image": "assets/guideline_list.png", "altText": "Quack logo" }, "completionEvents": [ @@ -323,7 +323,7 @@ "title": "Specify your custom Quack API endpoint", "description": "If you're running on a custom API endpoint, specify it first.\n[Set custom endpoint](command:quack.setEndpoint)", "media": { - "image": "media/quack-logo.png", + "image": "assets/quack-logo.png", "altText": "Quack logo" }, "completionEvents": [ @@ -335,7 +335,7 @@ "title": "Authenticate using GitHub", "description": "Click on **Authenticate** and follow the instructions.\n[Authenticate](command:quack.login)", "media": { - "image": "media/github_auth.png", + "image": "assets/github_auth.png", "altText": "GitHub authentication" }, "completionEvents": [ @@ -347,7 +347,7 @@ "title": "Request guidelines for a repo", "description": "If the selected repo doesn't have any guidelines yet, you will be ask whether you'd like to request some.", "media": { - "image": "media/quack-logo.png", + "image": "assets/quack-logo.png", "altText": "Quack logo" }, "completionEvents": [] @@ -357,7 +357,7 @@ "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/compliance_hint.png", + "image": "assets/compliance_hint.png", "altText": "Code compliance hint" }, "completionEvents": [