fix docs

.github/workflows/pr-title.yml

@@ -3,7 +3,7 @@ name: Pull Request Title Format
 on:
   pull_request:
     branches:
-      - '*'
+      - '**'
     types:
       - opened
       - reopened
@@ -16,10 +16,10 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
       - name: Check PR Title
-        uses: clowdhaus/actions/pr-title@v0.1.0
+        uses: clowdhaus/actions/pr-title@v0.5.0
         with:
-          on-fail-message: "Your PR title doesn't match the required format. The title should be in the conventional commit (https://www.conventionalcommits.org/en/v1.0.0-beta.4/) format. e.g.\n\n```\nchore: add pr title workflow\n```"
-          title-regex: '^(build|chore|ci|docs|feat|fix|perf|refactor|revert|style|test)?(!)?\:\s.*$'
+          on-fail-message: "Your PR title doesn't match the required format. The title should be in this format: \n\n```\nchore: update docs\n```"
+          title-regex: '^(chore|feat|fix|breaking)?(!)?\:\s.*$'
           github-token: ${{ secrets.GITHUB_TOKEN }}

package.json

@@ -22,7 +22,8 @@
     "test:watch": "vitest",
     "watch": "npm run --ws watch --if-present",
     "deploy": "npm run deploy --workspace @assetpack/docs",
-    "docs:start": "npm run start --workspace @assetpack/docs"
+    "docs:start": "npm run start --workspace @assetpack/docs",
+    "docs:build": "npm run build --workspace @assetpack/docs"
   },
   "husky": {
     "hooks": {

packages/assetpack/src/core/Asset.ts

@@ -110,7 +110,7 @@ export class Asset
     {
         if (this.isFolder)
         {
-            Logger.warn('[AssetPack] folders should not have buffers!. Contact the developer of Assetpack');
+            Logger.warn('[AssetPack] folders should not have buffers!. Contact the developer of AssetPack');
         }
 
         if (!this._buffer)
@@ -132,7 +132,7 @@ export class Asset
     {
         if (this.isFolder)
         {
-            Logger.warn('[AssetPack] folders should not have hashes. Contact the developer of the Assetpack');
+            Logger.warn('[AssetPack] folders should not have hashes. Contact the developer of the AssetPack');
         }
 
         this._hash ??= getHash(this.buffer);

packages/docs/docs/guide/configuration.md

@@ -28,7 +28,7 @@ The directory where you want your optimised assets to be outputted to.
 | ---------- | ------- | -------- |
 | `string[]` |         | No       |
 
-An optional array of ignore patterns. Any file path matching the patterns will not be processed by assetpack.
+An optional array of ignore patterns. Any file path matching the patterns will not be processed by AssetPack.
 
 ### cache
 
@@ -58,9 +58,9 @@ An optional string to set the log level.
 
 | Type     | Default | Required |
 | -------- | ------- | -------- |
-| `Pipe[]` |         | No       |
+| `Plugin[]` |         | No       |
 
-An array of pipes to use. For examples of pipes, see [Pipes](/docs/guide/pipes/overview#concepts).
+An array of pipes to use. For examples of pipes, see [Plugins](/docs/guide/pipes/overview#plugins).
 
 ### assetSettings
 

packages/docs/docs/guide/getting-started/installation.mdx

@@ -15,10 +15,10 @@ It uses a plugin based system to allow you to create your own plugins to do what
 
 ## Installation
 
-To install AssetPack, you need to install the `assetpack` package.
+To install AssetPack, you need to install the `@assetpack/core` package.
 
 ```bash
-npm install --save-dev assetpack
+npm install --save-dev @assetpack/core
 ```
 
 :::info COMPATIBILITY NOTE
@@ -35,7 +35,7 @@ First create a `.assetpack.js` file in the root of your project. This file shoul
 
 ```js
 // .assetpack.js
-import { compress } from 'assetpack';
+import { compress } from '@assetpack/core';
 
 export default {
     entry: './raw-assets',
@@ -52,15 +52,15 @@ Then to run AssetPack, you can use the CLI, run programatically, or use a build
 - [Programmatic](/docs/guide/getting-started/programmatic)
 - [Vite](/docs/guide/getting-started/vite)
 
-AssetPack has a number of built-in pipes for you to use, to see the full list of pipes, see the [Pipes](/docs/guide/pipes) page.
+AssetPack has a number of built-in pipes for you to use, to see the full list of pipes, see the [Pipes](/docs/guide/pipes/overview) page.
 
 ### PixiJS Setup
 
 If you are using AssetPack with PixiJS, you can use the `pixiPipes` function to add a pre-configured set of pipes, with an opinionated set of defaults for PixiJS.
 
 ```js
 // .assetpack.js
-import { compress, pixiPipes } from 'assetpack';
+import { compress, pixiPipes } from '@assetpack/core';
 
 export default {
     entry: './raw-assets',

packages/docs/docs/guide/getting-started/programmatic.md

@@ -14,7 +14,7 @@ To see a full list of configuration options, see the [API Reference](/docs/guide
 To use AssetPack programmatically, you need to import the `assetpack` function from the `assetpack` package, and call it with the following options:
 
 ```js
-import { AssetPack } from 'assetpack';
+import { AssetPack } from '@assetpack/core';
 
 const assetpack = new AssetPack({
     entry: './raw-assets',

packages/docs/docs/guide/getting-started/vite.md

@@ -12,7 +12,7 @@ To see a full list of configuration options, see the [API Reference](/docs/guide
 ```ts
 // vite.config.mts
 import { defineConfig, type Plugin, type ResolvedConfig } from 'vite';
-import { AssetPack } from 'assetpack';
+import { AssetPack } from '@assetpack/core';
 
 function assetpackPlugin(): Plugin {
     const apConfig = {

packages/docs/docs/guide/pipes/cache-buster.mdx

@@ -34,7 +34,7 @@ export default {
 
 ## Spine and Texture Packer
 
-When integrating with the [`texturePacker`](/docs/guides/pipes/texture-packer) plugin or your porject has spine atlas files,
+When integrating with the [`texturePacker`](/docs/guide/pipes/texture-packer) plugin or your porject has spine atlas files,
 you need to add the `texturePackerCacheBuster` / `spineAtlasCacheBuster` pipes immediately after the `cacheBuster` pipe.
 
 The `texturePackerCacheBuster` ensures that the JSON files internally update their asset names to reflect the newly hashed file names.

packages/docs/docs/guide/pipes/overview.mdx

@@ -17,8 +17,8 @@ The order of the plugins in the pipe is important, as each plugin processes the
 ## Plugins
 
 -   [Cache Buster](/docs/guide/pipes/cache-buster): Adds hashes to file names to ensure that assets are correctly updated when they change.
--   [Audio](/docs/guide/pipes/audio): Converts and compresses audio files using FFmpeg.
--   [FFmpeg](/docs/guide/pipes/audio): Converts files to any other file type using the FFmpeg API.
+-   [Audio](/docs/guide/pipes/ffmpeg): Converts and compresses audio files using FFmpeg.
+-   [FFmpeg](/docs/guide/pipes/ffmpeg): Converts files to any other file type using the FFmpeg API.
 -   [Compression](/docs/guide/pipes/compress): Compresses images into different formats.
 -   [Mipmaps](/docs/guide/pipes/mipmap): Generates mipmaps for images.
 -   [JSON](/docs/guide/pipes/json): Minifies JSON files.