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

Commit

Permalink
refactor: Renames media/ folder to assets/ (#34)
Browse files Browse the repository at this point in the history
* refactor: Relocates static content to assets/

* ci: Updates labeler
  • Loading branch information
frgfm authored Jan 27, 2024
1 parent 852e9e3 commit 4c75531
Show file tree
Hide file tree
Showing 24 changed files with 26 additions and 26 deletions.
2 changes: 1 addition & 1 deletion .github/labeler.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
"ext: media":
- media/*
- assets/*

"ext: styles":
- styles/*
Expand Down
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,15 +55,15 @@
</a>
</p>

![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.

## Quick Tour

### 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:

Expand All @@ -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.

Expand Down
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
42 changes: 21 additions & 21 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down Expand Up @@ -124,7 +124,7 @@
{
"id": "quack-companion",
"title": "Quack Companion",
"icon": "media/dark/quack.svg"
"icon": "assets/dark/quack.svg"
}
]
},
Expand All @@ -134,15 +134,15 @@
"type": "tree",
"id": "quack.authView",
"name": "Authentication",
"icon": "media/dark/quack.svg",
"icon": "assets/dark/quack.svg",
"contextualTitle": "Authentication",
"when": "!quack.isAuthenticated"
},
{
"type": "tree",
"id": "quack.guidelineTreeView",
"name": "Guidelines",
"icon": "media/dark/quack.svg",
"icon": "assets/dark/quack.svg",
"contextualTitle": "Guidelines",
"when": "quack.isAuthenticated"
}
Expand Down Expand Up @@ -174,26 +174,26 @@
"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"
}
},
{
"command": "quack.checkCodeAgainstGuideline",
"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"
}
},
{
"command": "quack.checkCodeAgainstRepo",
"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"
}
}
],
Expand Down Expand Up @@ -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": [
Expand All @@ -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": []
Expand All @@ -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": []
Expand All @@ -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": [
Expand All @@ -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": [
Expand All @@ -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": [
Expand All @@ -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": [
Expand All @@ -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": []
Expand All @@ -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": [
Expand Down

0 comments on commit 4c75531

Please sign in to comment.