docs: add links for wiki and discussion to README. (#89)

* docs: add links for wiki and discussion to README.

* add logging to CONTRIBUTING.md

* replace demo with codecompanion chat.

Author: Davidyz

README.md

@@ -4,7 +4,7 @@
 [![Test and Coverage](https://github.com/Davidyz/VectorCode/actions/workflows/test_and_cov.yml/badge.svg)](https://github.com/Davidyz/VectorCode/actions/workflows/test_and_cov.yml)
 [![pypi](https://img.shields.io/pypi/v/vectorcode.svg)](https://pypi.org/project/vectorcode/)
 
-VectorCode is a code repository indexing tool. It helps you write better prompt
+VectorCode is a code repository indexing tool. It helps you build better prompt
 for your coding LLMs by indexing and providing information about the code
 repository you're working on. This repository also contains the corresponding
 neovim plugin because that's what I used to write this tool.
@@ -32,19 +32,11 @@ neovim plugin because that's what I used to write this tool.
 ## Why VectorCode?
 LLMs usually have very limited understanding about close-source projects, projects
 that are not well-known, and cutting edge developments that have not made it into
-releases. Their capabilities on these projects are quite limited. Take my little
-toy sudoku-solving project as an example: When I wrote the first few lines and
-want the LLM to fill in the list of solvers that I implemented in
-`solver_candidates`, without project context, the completions are simply random 
-guesses that *might* be part of another sudoku project:
-![](./images/sudoku_no_rag.png)
-But with RAG context provided by VectorCode, my completion LLM was able to
-provide completions that I actually implemented:
-![](./images/sudoku_with_rag.png)
-This makes the completion results far more usable. 
-[A similar strategy](https://docs.continue.dev/customize/deep-dives/codebase) 
-is implemented in [continue](https://www.continue.dev/), a popular AI completion
-and chat plugin available on VSCode and JetBrain products.
+releases. Their capabilities on these projects are quite limited. With
+VectorCode, you can easily (and programmatically) inject task-relevant context
+from the project into the prompt. This significantly improves the quality of the
+model output and reduce hallucination.
+![](./images/codecompanion_chat.png)
 
 ## Documentation
 
@@ -57,6 +49,11 @@ and chat plugin available on VSCode and JetBrain products.
 - For the setup and usage of the command-line tool, see [the CLI documentation](./docs/cli.md);
 - For neovim users, after you've gone through the CLI documentation, please refer to 
   [the neovim plugin documentation](./docs/neovim.md) for further instructions.
+- Additional resources:
+  - the [wiki](https://github.com/Davidyz/VectorCode/wiki) for extra tricks and
+    tips that will help you get the most out of VectorCode;
+  - the [discussions](https://github.com/Davidyz/VectorCode/discussions) where
+    you can ask general questions and share your cool usages about VectorCode.
 
 If you're trying to contribute to this project, take a look at [the contribution
 guide](./docs/CONTRIBUTING.md), which contains information about some basic

docs/CONTRIBUTING.md

@@ -20,9 +20,17 @@ run tests, and `make coverage` to generate a coverage report. The testing and
 coverage report are also in the CI configuration, but it might still help to run
 them locally before you open the PR.
 
+You may also find it helpful to 
+[enable logging](https://github.com/Davidyz/VectorCode/blob/main/docs/cli.md#debugging-and-diagnosing) 
+for the CLI when developing new features or working on fixes.
+
 # Neovim Plugin
 
 At the moment, there isn't much to cover on here. As long as the code is 
 formatted (stylua) and appropriately type-annotated, you're good. I do have 
 plans to write some tests, but before that happens, formatting and type 
 annotations are the only things that you need to take special care of.
+
+You may find it useful to 
+[enable logging](https://github.com/Davidyz/VectorCode/blob/main/docs/cli.md#debugging-and-diagnosing) 
+when you're poking around the codebase.