fix: update documentation website URL (#306)

withcatai · Sep 3, 2024 · 51265c8 · 51265c8
1 parent 660651a
commit 51265c8
Show file tree

Hide file tree

Showing 7 changed files with 12 additions and 12 deletions.
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
@@ -29,4 +29,4 @@
 - [ ] This pull request links relevant issues as `Fixes #0000`
 - [ ] There are new or updated unit tests validating the change
 - [ ] Documentation has been updated to reflect this change
-- [ ] The new commits and pull request title follow conventions explained in [pull request guidelines](https://withcatai.github.io/node-llama-cpp/guide/contributing) (PRs that do not follow this convention will not be merged)
+- [ ] The new commits and pull request title follow conventions explained in [pull request guidelines](https://node-llama-cpp.withcat.ai/guide/contributing) (PRs that do not follow this convention will not be merged)
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -299,7 +299,7 @@ jobs:
       - name: Generate docs with updated version
         if: steps.set-npm-url.outputs.npm-url != ''
         env:
-          DOCS_URL_BASE: "/node-llama-cpp/"
+          DOCS_URL_BASE: "/"
         run: |
           export DOCS_PACKAGE_VERSION=$(cat .semanticRelease.npmPackage.deployedVersion.txt)
           npm run docs:build

diff --git a/.vitepress/config.ts b/.vitepress/config.ts
@@ -14,7 +14,7 @@ const urlBase = env.get("DOCS_URL_BASE").asString();
 const packageVersion = env.get("DOCS_PACKAGE_VERSION").default(packageJson.version).asString();
 const googleSiteVerificationCode = "7b4Hd_giIK0EFsin6a7PWLmM_OeaC7APLZUxVGwwI6Y";
 
-const hostname = "https://withcatai.github.io/node-llama-cpp/";
+const hostname = "https://node-llama-cpp.withcat.ai/";
 
 const chatWrappersOrder = [
     "GeneralChatPromptWrapper",

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -1 +1 @@
-# Moved [here](https://withcatai.github.io/node-llama-cpp/guide/contributing)
+# Moved [here](https://node-llama-cpp.withcat.ai/guide/contributing)
diff --git a/README.md b/README.md
@@ -26,10 +26,10 @@
 * Up-to-date with the latest version of `llama.cpp`. Download and compile the latest release with a single CLI command.
 * Force a model to generate output in a parseable format, like JSON, or even force it to follow a specific JSON schema
 
-## [Documentation](https://withcatai.github.io/node-llama-cpp/)
-* [Getting started guide](https://withcatai.github.io/node-llama-cpp/guide/)
-* [API reference](https://withcatai.github.io/node-llama-cpp/api/classes/LlamaModel)
-* [CLI help](https://withcatai.github.io/node-llama-cpp/guide/cli/)
+## [Documentation](https://node-llama-cpp.withcat.ai/)
+* [Getting started guide](https://node-llama-cpp.withcat.ai/guide/)
+* [API reference](https://node-llama-cpp.withcat.ai/api/classes/LlamaModel)
+* [CLI help](https://node-llama-cpp.withcat.ai/guide/cli/)
 * [Changelog](https://github.com/withcatai/node-llama-cpp/releases)
 * [Roadmap](https://github.com/orgs/withcatai/projects/1)
 
@@ -72,10 +72,10 @@ const a2 = await session.prompt(q2);
 console.log("AI: " + a2);
 ```
 
-> For more examples, see the [getting started guide](https://withcatai.github.io/node-llama-cpp/guide/)
+> For more examples, see the [getting started guide](https://node-llama-cpp.withcat.ai/guide/)
 
 ## Contributing
-To contribute to `node-llama-cpp` read the [contribution guide](https://withcatai.github.io/node-llama-cpp/guide/contributing).
+To contribute to `node-llama-cpp` read the [contribution guide](https://node-llama-cpp.withcat.ai/guide/contributing).
 
 ## Acknowledgements
 * llama.cpp: [ggerganov/llama.cpp](https://github.com/ggerganov/llama.cpp)

diff --git a/package.json b/package.json
@@ -96,7 +96,7 @@
   "bugs": {
     "url": "https://github.com/withcatai/node-llama-cpp/issues"
   },
-  "homepage": "https://withcatai.github.io/node-llama-cpp/",
+  "homepage": "https://node-llama-cpp.withcat.ai",
   "devDependencies": {
     "@commitlint/cli": "^17.7.1",
     "@commitlint/config-conventional": "^17.7.0",

diff --git a/src/config.ts b/src/config.ts
@@ -59,7 +59,7 @@ export const defaultChatSystemPrompt = "You are a helpful, respectful and honest
 export const cliBinName = "node-llama-cpp";
 export const npxRunPrefix = "npx --no ";
 
-const documentationUrl = "https://withcatai.github.io/node-llama-cpp";
+const documentationUrl = "https://node-llama-cpp.withcat.ai";
 export const documentationPageUrls = {
     CUDA: documentationUrl + "/guide/CUDA"
 } as const;