GitHub Pages Setup

Enable web hosting for NeuAI documentation

Home Tutorial Examples

Overview

GitHub Pages allows you to host the NeuAI documentation and web interface directly from your repository. Once enabled, the following pages become accessible:

Landing Page: https://kody-w.github.io/localFirstTools/docs/neuai/

Tutorial: https://kody-w.github.io/localFirstTools/docs/neuai/tutorial.html

Install Wizard: https://kody-w.github.io/localFirstTools/neuai-installer-wizard.html

Web App: https://kody-w.github.io/localFirstTools/neuai-web.html

1 Navigate to Repository Settings

Go to your repository: github.com/kody-w/localFirstTools
Click the Settings tab in the repository navigation
In the left sidebar, scroll down and click Pages

1 Settings → Pages (in left sidebar)

2 Configure Source Branch

Under "Build and deployment", configure the source:

Source: Select "Deploy from a branch"
Branch: Select main (or revert if that's your primary branch)
Folder: Select / (root)
Click Save

Branch Note: Make sure to select the correct branch. Check your repository's default branch in Settings → General → Default branch.

2 Source: Deploy from a branch
Branch: main / (root)

3 Wait for Deployment

After saving, GitHub will automatically build and deploy your site. This typically takes 1-3 minutes.

Stay on the Pages settings page
Watch for the deployment status at the top
Once complete, you'll see: "Your site is live at..."

Tip: You can also check deployment status under the Actions tab in your repository.

Success! Once deployed, your NeuAI documentation will be available at:
https://kody-w.github.io/localFirstTools/docs/neuai/

4 Verify Deployment

Test that all pages are accessible:

Landing page loads at /docs/neuai/
Tutorial page loads at /docs/neuai/tutorial.html
Examples page loads at /docs/neuai/examples.html
Install wizard loads at /neuai-installer-wizard.html
Web app loads at /neuai-web.html
All navigation links work correctly

Optional: Custom Domain

If you want to use a custom domain (e.g., neuai.yourdomain.com):

In the Pages settings, enter your custom domain
Configure DNS with your domain provider:
DNS Records # For apex domain (yourdomain.com): A @ 185.199.108.153 A @ 185.199.109.153 A @ 185.199.110.153 A @ 185.199.111.153 # For subdomain (neuai.yourdomain.com): CNAME neuai kody-w.github.io.
Wait for DNS propagation (can take up to 24 hours)
Enable "Enforce HTTPS" once the certificate is provisioned

Troubleshooting

404 Page Not Found

Verify the file paths are correct (case-sensitive on GitHub Pages)
Check that the branch selected in Pages settings matches your primary branch
Wait a few minutes and try again - deployments can take time

Pages Not Updating

Hard refresh (Ctrl+Shift+R or Cmd+Shift+R)
Check the Actions tab for failed deployments
Verify your changes were pushed to the correct branch

HTTPS Certificate Issues

Wait 24 hours for certificate provisioning
Try removing and re-adding the custom domain
Ensure DNS records are correctly configured

Quick Links

After enabling GitHub Pages, share these links:

                # Documentation
https://kody-w.github.io/localFirstTools/docs/neuai/

# Direct Install Command
curl -sSL https://kody-w.github.io/localFirstTools/docs/neuai/install.sh | bash

# Web Interface
https://kody-w.github.io/localFirstTools/neuai-web.html

# Interactive Tutorial
https://kody-w.github.io/localFirstTools/docs/neuai/tutorial.html
            

Open GitHub Pages Settings