docs(readme): update README and walkthrough for the release (#70)

* refactor(media): rename assets to media

* docs(readme): update repo reference

* refactor(webview): update style location

* docs: update assets location

* ci(github): update labeler

* fix(util): avoid redirect on API

* docs(readme): update README

* docs(walkthrough): update extension walkthrough

* docs(changelog): update changelog

* build(version): bump version

* docs(changelog): update content for release

Author: frgfm

.github/labeler.yml

@@ -1,6 +1,6 @@
-'ext: assets':
+'ext: media':
   - changed-files:
-      - any-glob-to-any-file: assets/*
+      - any-glob-to-any-file: media/*
 
 'module: activation':
   - changed-files:

.github/verify_labels.py

@@ -32,7 +32,7 @@
     "topic: build",
     "topic: ci",
     "topic: style",
-    "ext: assets",
+    "ext: media",
     "module: activation",
     "module: commands",
     "module: util",

CHANGELOG.md

@@ -7,6 +7,24 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.0.7] - 2024-03-28
+
+### Added
+
+- Update readme and walkthroughs (#70)
+- Replaces axios with native fetch (#68)
+- Update API synchronization to preserve guidelines on remote (#64, #65)
+- Revamp guideline view (#63)
+- Add multi-turn chat view (#62)
+- Remove unused imports (#60)
+- Add PR label & title automatic check (#55)
+- Add precommit hooks to help contributors (#37)
+- Update marketplace metadata (#33)
+
+### Fixed
+
+- Fix the semver convention for package (#59)
+
 ## [0.0.6] - 2023-12-15
 
 ### Added

CONTRIBUTING.md

@@ -6,11 +6,10 @@ 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
-- [`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
+- [`src/`](https://github.com/quack-ai/companion-vscode/blob/main/src/) - The actual platform codebase
+- [`media/`](https://github.com/quack-ai/companion-vscode/blob/main/media/) - Binary assets & styling configs
+- [`.vscode/`](https://github.com/quack-ai/companion-vscode/blob/main/.vscode/) - VSCode specific config
+- [`.github/`](https://github.com/quack-ai/companion-vscode/blob/main/.github/) - Configuration for GitHub workflow
 
 ## Continuous Integration
 
@@ -51,26 +50,26 @@ The file should be placed at the root folder of your local copy of the project.
 
 ### Feature requests & bug report
 
-Whether you encountered a problem, or you have a feature suggestion, your input has value and can be used by contributors to reference it in their developments. For this purpose, we advise you to use Github [issues](https://github.com/quack-ai/companion/issues).
+Whether you encountered a problem, or you have a feature suggestion, your input has value and can be used by contributors to reference it in their developments. For this purpose, we advise you to use Github [issues](https://github.com/quack-ai/companion-vscode/issues).
 
 First, check whether the topic wasn't already covered in an open / closed issue. If not, feel free to open a new one! When doing so, use issue templates whenever possible and provide enough information for other contributors to jump in.
 
 ### Questions
 
-If you are wondering how to do something with Contribution API, or a more general question, you should consider checking out Github [discussions](https://github.com/quack-ai/companion/discussions). See it as a Q&A forum, or the project-specific StackOverflow!
+If you are wondering how to do something with Contribution API, or a more general question, you should consider checking out Github [discussions](https://github.com/quack-ai/companion-vscode/discussions). See it as a Q&A forum, or the project-specific StackOverflow!
 
 ## Submitting a Pull Request
 
 ### Preparing your local branch
 
-1 - Fork this [repository](https://github.com/quack-ai/companion) by clicking on the "Fork" button at the top right of the page. This will create a copy of the project under your GitHub account (cf. [Fork a repo](https://docs.github.com/en/get-started/quickstart/fork-a-repo)).
+1 - Fork this [repository](https://github.com/quack-ai/companion-vscode) by clicking on the "Fork" button at the top right of the page. This will create a copy of the project under your GitHub account (cf. [Fork a repo](https://docs.github.com/en/get-started/quickstart/fork-a-repo)).
 
 2 - [Clone your fork](https://docs.github.com/en/repositories/creating-and-managing-repositories/cloning-a-repository) to your local disk and set the upstream to this repo
 
 ```shell
-git clone [email protected]:<YOUR_GITHUB_ACCOUNT>/companion.git
-cd companion
-git remote add upstream https://github.com/quack-ai/companion.git
+git clone [email protected]:<YOUR_GITHUB_ACCOUNT>/companion-vscode.git
+cd companion-vscode
+git remote add upstream https://github.com/quack-ai/companion-vscode.git
 ```
 
 3 - You should not work on the `main` branch, so let's create a new one

README.md

@@ -2,20 +2,21 @@
   <a href="https://quack-ai.com"><img src="https://quack-ai.com/quack.png" width="100" height="100"></a>
 </p>
 <h1 align="center">
- Quack Companion
+ Quack Companion - IDE extension
 </h1>
 
 <p align="center">
-  <a href="https://github.com/quack-ai/companion">VSCode extension</a> ・
-  <a href="https://github.com/quack-ai/contribution-api">Backend API</a> ・
-  <a href="https://github.com/quack-ai/platform">Frontend dashboard</a> ・
+<p align="center">
+  <a href="https://github.com/quack-ai/companion">API</a> ・
+  <a href="https://github.com/quack-ai/companion-vscode">VSCode extension</a> ・
   <a href="https://docs.quackai.com">Documentation</a>
 </p>
+</p>
 <h2 align="center"></h2>
 
 <p align="center">
-  <a href="https://github.com/quack-ai/companion/actions/workflows/builds.yml">
-    <img alt="CI Status" src="https://img.shields.io/github/actions/workflow/status/quack-ai/companion/builds.yml?branch=main&label=CI&logo=github&style=flat-square">
+  <a href="https://github.com/quack-ai/companion-vscode/actions/workflows/builds.yml">
+    <img alt="CI Status" src="https://img.shields.io/github/actions/workflow/status/quack-ai/companion-vscode/builds.yml?branch=main&label=CI&logo=github&style=flat-square">
   </a>
   <a href="https://github.com/eslint/eslint">
     <img src="https://img.shields.io/badge/Linter-ESLint-4B32C3?style=flat-square&logo=ESLint&logoColor=white" alt="eslint">
@@ -36,43 +37,46 @@
     <img src="https://img.shields.io/open-vsx/v/quackai/quack-companion?logo=opensourceinitiative&logoColor=fff&style=flat-square&label=Open%20VSX%20Registry" alt="Open VSX Registry">
   </a>
   <a href="https://github.com/nodejs/node">
-    <img src="https://img.shields.io/badge/Node-18-339933?style=flat-square&logo=nodedotjs&logoColor=white" alt="Node.js">
+    <img src="https://img.shields.io/badge/Node-20-339933?style=flat-square&logo=nodedotjs&logoColor=white" alt="Node.js">
   </a>
-  <a href="https://github.com/quack-ai/companion/blob/main/LICENSE">
+  <a href="https://github.com/quack-ai/companion-vscode/blob/main/LICENSE">
     <img src="https://img.shields.io/badge/License-Apache 2.0-blue?style=flat-square" alt="license">
   </a>
 </p>
 
 <p align="center">
-  <!-- <a href="https://discord.gg/E9rY3bVCWd">
-    <img src="https://dcbadge.vercel.app/api/server/E9rY3bVCWd?style=flat" alt="discord"/>
-  </a> -->
-  <a target="_blank" href="https://discord.gg/E9rY3bVCWd" style="background:none">
-    <img src="https://img.shields.io/badge/Discord-join-continue.svg?labelColor=191937&color=6F6FF7&logo=discord" />
+  <a href="https://discord.gg/E9rY3bVCWd">
+    <img src="https://img.shields.io/badge/Discord-Community-5865F2?style=flat-square&logo=discord&logoColor=white" />
   </a>
   <a href="https://twitter.com/quack_ai">
     <img src="https://img.shields.io/badge/-@quack_ai-1D9BF0?style=flat-square&logo=twitter&logoColor=white" alt="Twitter">
   </a>
 </p>
 
-![Compliance hint](assets/compliance_hint.png)
+Smart linting and code chat overcharged by your team insights in VSCode
 
-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.
+https://github.com/quack-ai/companion-vscode/assets/26927750/019a0610-2bca-48a4-ad35-e0a8241617d5
 
 ## Quick Tour
 
-### Contribution guidance
+### Code chat
+
+![Code chat](https://github.com/quack-ai/companion-vscode/assets/26927750/0577baa8-e1b8-479a-b63e-939e8d5052be)
 
-![Guideline view](assets/guideline_list.png)
+### Coding guideline curation
 
-Once installed, when you open a public GitHub project, the extension will give you a new tab where you'll find:
+![Guideline view](https://github.com/quack-ai/companion-vscode/assets/26927750/118eea21-1ef5-42a9-af4c-cb8a1f2c5c3a)
 
-- **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)
+Once installed, when you open a project, the extension will give you a new tab where you'll find:
+
+- **Guideline curation**: curate your software insights with your team
+- **Code chat**: ChatGPT but for developers
+- **Smart linting** (temporarily disabled)
+- **Code completion** (coming soon)
 
 ### Walthrough tutorial
 
-![Developer walkthrough](assets/dev_walkthrough.png)
+![Developer walkthrough](https://github.com/quack-ai/companion-vscode/assets/26927750/bd4fd595-991f-41d9-a125-f42cf2af6642)
 
 With our walkthrough tutorial, you're only a few clicks away from having your own coding companion.
 
@@ -129,8 +133,6 @@ Copyright (C) 2023-2024, Quack AI.
 This program is licensed under the Apache License 2.0.
 See LICENSE or go to <https://www.apache.org/licenses/LICENSE-2.0> for full license details.
 
-[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fquack-ai%2Fquack-companion-vscode.svg?type=large&issueType=license)](https://app.fossa.com/projects/git%2Bgithub.com%2Fquack-ai%2Fquack-companion-vscode?ref=badge_large&issueType=license)
-
 ## Contributing
 
 Feeling like improving the interface? Or perhaps submitting a new feature idea? Any sort of contribution is greatly appreciated!