Phil WebCraftPhil

AGENTS Guide

This document explains how automated agents (e.g., GitHub Copilot, OpenAI Codex, Anthropic Claude) and human contributors should work in this repository. Follow these practices whenever you modify the codebase, submit changes, or automate workflows.

1. Required Checks

Linting: Run npm run lint after making any code changes and fix all issues before committing.
Build: Run npm run build to ensure the Next.js project compiles without errors.

MeiliSearch

⚡ Lightning Fast, Ultra Relevant, and Typo-Tolerant Search Engine 🔍

Github | Website

Deploying a subfolder to GitHub Pages

Sometimes you want to have a subdirectory on the master branch be the root directory of a repository’s gh-pages branch. This is useful for things like sites developed with Yeoman, or if you have a Jekyll site contained in the master branch alongside the rest of your code.

For the sake of this example, let’s pretend the subfolder containing your site is named dist.

Step 1

Remove the dist directory from the project’s .gitignore file (it’s ignored by default by Yeoman).

	# create files in an otherwise empty directory
	mkdir files
	cd files
	touch setup.sh # entry point after extraction
	touch file.txt # supporting data used by setup.sh

	# create archive
	tar -pczf ../archive.tar.gz *
	cd ..

	-----BEGIN PGP PUBLIC KEY BLOCK-----
	Comment: https://keybase.io/download
	Version: Keybase Go 6.0.1 (windows)

	xsFNBGR0mpwBEADhCyeeMMHR1jP0edMoX7EUxbh/pAq/RQmVQSBndBLAFmyVHVEM
	s+P0zgjZCfS/yHAdtBm+YF0ftOYOkMXQoupGKhTQpwwOXjMweWlLPGl/1UnsbM4k
	GlOP4bp5LIJvkesGjbakYg/BNcPItFeZD4kSnib3lSKh/Bs58qwHJFYzhFWVxeBN
	JhWWKQTtvVlsun+M1jMLvJaaNuVIBCkuG9ND7bhDH9yeQdgJbCTCRWeLlWLi7198
	+U8K6Lk6rtauIELXBRWtzWeKiGwBbFwwE4NyVr7xpcBUub30akgrxoDPZ5C6oNSw
	LboE3PfyYESOkLbO9C5/24Frz7InD5LbgG7a3IsaU/A6lWN5Nw7nOX5wSKuMe3dU