docs: improvements (#357)

.vitepress/config.ts

@@ -321,6 +321,7 @@ export default defineConfig({
         ]
     },
     themeConfig: {
+        logo: "/icon.svg",
         editLink: {
             pattern: "https://github.com/withcatai/node-llama-cpp/edit/master/docs/:path"
         },

.vitepress/theme/style.css

@@ -3,13 +3,15 @@
     --vp-c-brand-2: #cc6e3a;
     --vp-c-brand-3: #cd8156;
     --vp-c-brand-soft: rgb(255 156 100 / 14%);
+    color-scheme: light;
 }
 
 .dark {
     --vp-c-brand-1: #ffc7a8;
     --vp-c-brand-2: #e78e5c;
     --vp-c-brand-3: #dd773e;
     --vp-c-brand-soft: rgb(255 156 100 / 16%);
+    color-scheme: dark;
 }
 
 :root {
@@ -74,6 +76,13 @@
     --vp-c-neutral-inverse: rgb(0 0 0 / 60%);
 }
 
+.VPNavBarTitle>.title>.logo {
+    margin-bottom: -2px;
+}
+.VPNavBar.home .VPNavBarTitle>.title>.logo {
+    display: none;
+}
+
 .VPNavBar:before {
     display: block;
     position: absolute;

docs/guide/choosing-a-model.md

@@ -83,7 +83,7 @@ npx --no node-llama-cpp inspect estimate <model-file-url>
 ```
 :::
 
-### What do you need this model for? (chat, code completion, analyzing data, classification, etc.)
+### What do you need this model for? (chat, code completion, analyzing data, classification, etc.) {#model-purpose}
 There are plenty of models with different areas of expertise and capabilities.
 
 When you choose a model that is more specialized in the task you need it for, it will usually perform better than a general model.

docs/guide/downloading-models.md

@@ -126,7 +126,7 @@ or the [`resolveModelFile`](../api/functions/resolveModelFile.md) method will au
 Alternatively, you can use the token in the [`tokens`](../api/type-aliases/ModelDownloaderOptions.md#tokens) option when using [`createModelDownloader`](../api/functions/createModelDownloader.md) or [`resolveModelFile`](../api/functions/resolveModelFile.md).
 
 ## Inspecting Remote Models
-You can inspect the metadata of a remote model without downloading it by either using the [`inspect gguf` command](../cli/inspect/gguf.md) with a URL,
+You can inspect the metadata of a remote model without downloading it by either using the [`inspect gguf`](../cli/inspect/gguf.md) command with a URL,
 or using the [`readGgufFileInfo`](../api/functions/readGgufFileInfo.md) method with a URL:
 ```typescript
 import {readGgufFileInfo} from "node-llama-cpp";
@@ -140,7 +140,7 @@ const modelMetadata = await readGgufFileInfo("<model url>");
 It's handy to check the compatibility of a remote model with your current machine hardware before downloading it,
 so you won't waste time downloading a model that won't work on your machine.
 
-You can do so using the [`inspect estimate` command](../cli/inspect/estimate.md) with a URL:
+You can do so using the [`inspect estimate`](../cli/inspect/estimate.md) command with a URL:
 ```shell
 npx --no node-llama-cpp inspect estimate <model-url>
 ```

docs/guide/index.md

@@ -55,6 +55,8 @@ We recommend getting a GGUF model from either [Michael Radermacher on Hugging Fa
 
 We recommend starting by getting a small model that doesn't have a lot of parameters just to ensure everything works, so try downloading a `7B`/`8B` parameters model first (search for models with both `7B`/`8B` and `GGUF` in their name).
 
+To ensure you can chat with the model, make sure you [choose an Instruct model](./choosing-a-model.md#model-purpose) by looking for `Instruct` or `it` in the model name.
+
 For improved download speeds, you can use the [`pull`](../cli/pull.md) command to download a model:
 ```shell
 npx --no node-llama-cpp pull --dir ./models <model-file-url>

docs/guide/troubleshooting.md

@@ -151,3 +151,8 @@ const context = await model.createContext({
 
 If you found that the memory estimation is indeed inaccurate,
 please [open a new issue on GitHub](https://github.com/withcatai/node-llama-cpp/issues/new/choose) with a link to the model you're using and the output of the [`inspect measure`](../cli/inspect/measure.md) command.
+
+## Getting an `The specified module could not be found \\?\C:\Users\Administrator\AppData\Roaming\npm\node_modules` Error on a Windows Machine
+The common cause for this issue is when using the `Administrator` to run `npm install` and then trying to run the code with a different user.
+
+Ensure you're not using the `Administrator` user for `npm install` nor to run the code.

test/modelDependent/codegemma/parallel.test.ts

@@ -166,10 +166,10 @@ describe("CodeGemma", () => {
             });
 
             const resPromise = completion.generateCompletion("const singleLineArrayFromOneToHundred = [1, 2, 3, ", {
-                maxTokens: 40
+                maxTokens: 20
             });
             const resPromise2 = completion2.generateCompletion("const singleLineArrayFromOneToHundred = [100, 99, 98, 97, 96, ", {
-                maxTokens: 40
+                maxTokens: 20
             });
 
             const [