Merge pull request #966 from 10up/enhancement/docs

Replace hookdoc with WP Hooks Documentor

Author: dkotter

.eslintignore

@@ -3,5 +3,5 @@ node_modules
 tests/*
 vendor/*
 bin/*
-hookdocs/*
+wp-hooks-docs/*
 docs/*

.github/hookdoc-tmpl/README.md

@@ -0,0 +1,42 @@
+name: Build Developer Docs
+
+on:
+  push:
+    branches:
+    - trunk
+
+jobs:
+  release:
+    name: Push (merge) to trunk
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: Checkout
+      uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
+
+    - name: Setup proper PHP version
+      uses: shivammathur/setup-php@9e72090525849c5e82e596468b86eb55e9cc5401 # v2.32.0
+      with:
+        php-version: 8.3
+
+    - name: Setup node
+      uses: actions/setup-node@cdca7365b2dadb8aad0a33bc7601856ffabcc48e # v4.3.0
+      with:
+        node-version-file: .nvmrc
+
+    - name: Install dependencies and build assets
+      run: |
+        npm install
+        npm run build
+        npm run makepot
+        composer install --no-dev -o
+
+    - name: Build docs
+      run: |
+        npm run build:docs
+
+    - name: Deploy docs update
+      uses: peaceiris/actions-gh-pages@4f9cc6602d3f66b9c108549d475ec49e8ef4d45e # v4.0.0
+      with:
+        github_token: ${{ secrets.GITHUB_TOKEN }}
+        publish_dir: './docs/build'

.github/hookdoc-tmpl/layout.tmpl

@@ -39,11 +39,3 @@ jobs:
         GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
         MESSAGE: 'Release: ({sha}) {msg}'
 
-    - name: Build docs
-      run: npm run build:docs
-
-    - name: Deploy docs update
-      uses: peaceiris/actions-gh-pages@4f9cc6602d3f66b9c108549d475ec49e8ef4d45e # v4.0.0
-      with:
-        github_token: ${{ secrets.GITHUB_TOKEN }}
-        publish_dir: './docs'

.github/hookdoc-tmpl/static/styles-10up.css

@@ -50,3 +50,6 @@ tests/cypress/screenshots
 tests/cypress/videos
 tests/cypress/reports
 .wp-env.override.json
+
+# docs
+wp-hooks-docs/docs/01.get-started/05.CHANGELOG.md

.github/workflows/build-docs.yml

@@ -814,7 +814,36 @@ To set up Stable Diffusion, follow the steps below:
 
 ## WP CLI Commands
 
-- Check out the [ClassifAI docs](https://10up.github.io/classifai/).
+- Check out the [ClassifAI docs](https://10up.github.io/classifai/advanced-docs/wp-cli).
+
+## Building and Running Documentation Site
+
+The ClassifAI documentation site is built using [WP Hooks Documentor](https://github.com/10up/wp-hooks-documentor). Follow these steps to build and run the documentation site locally:
+
+### 1. Build Documentation
+
+```bash
+# Install dependencies and build the plugin
+npm i && npm run build:docs
+```
+
+This will:
+- Install all required dependencies
+- Process all hook documentation from the codebase
+- Generate the documentation site in the `./docs` directory
+
+### 2. Run Documentation Site Locally
+
+```bash
+# Navigate to docs directory and start the server
+cd ./docs && npm run serve
+```
+
+The documentation site will be available at [http://localhost:3000](http://localhost:3000).
+
+### 3. Deployment
+
+The documentation site will automatically deploy to GitHub Pages when changes are merged into the `trunk` branch. You can view the live documentation at [https://10up.github.io/classifai/](https://10up.github.io/classifai/).
 
 ## Frequently Asked Questions