GitHub Actions Deployment

The docs repo builds a static Docusaurus site and copies the result to IIS on a self-hosted Windows runner.

The browser editor talks to the hosted HyperAI API. These workflows deploy the docs site.

Automatic deployment

.github/workflows/deploy.yml runs on pushes to main or master.

The workflow:

1. Checks out the repo and initializes submodules.
2. Installs npm dependencies.
3. Builds the site.
4. Replaces the contents of D:\hyperai_data\docs.hyperai.io.
5. Writes the IIS web.config.

A successful build alone does not confirm the IIS site updated. Check the copy step, generated configuration, and served page.

Manual deployment

Run Manual Deploy HyperSpin Docs from GitHub Actions. Choose the branch and destination:

Environment	Destination
production	D:\hyperai_data\docs.hyperai.io
staging	D:\hyperai_data\docs-staging.hyperai.io
test	D:\hyperai_data\docs-test.hyperai.io

The workflow replaces the selected destination's contents. Use staging to review changes before publishing to production.

The Docusaurus site URL stays configured in docusaurus.config.js. Choosing staging changes the copy destination, rather than rewriting site metadata.

Runner requirements

• A registered self-hosted Windows runner.
• Node.js and npm matching the installed Docusaurus version.
• Write access to the destination folder.
• IIS with URL Rewrite.
• ARR proxy support if retaining the generated local API proxy.

The runner's service account needs the required folder access.

IIS routing

Both workflows generate an API reverse-proxy rule before the Docusaurus route rule. The proxy sends /api/* to http://localhost:3001/api/*.

The current browser editor uses https://api.hyperai.io/Docs/GetFile and /Docs/SaveFile directly. A local port-3001 service is separate from this editor path.

The repository contains no api/ backend and no API installation or PM2 restart step. Manage any retained local proxy service through its own deployment.

Verify deployment

1. Confirm the workflow built and copied the site.
2. Open the destination's web.config.
3. Load the updated page through the website.
4. Reload a nested docs URL.
5. Check images and navigation.
6. Test an authorized editor save separately when the editor integration changes.

If deployment fails

• Build failure: reproduce with npm run build.
• Copy failure: check the runner account and folder permissions.
• Routing failure: check URL Rewrite and the generated configuration.
• Editor failure: inspect the hosted API response through browser developer tools.

See IIS Deployment and Browser Editor.