From 59220ab5c7654d06ea4cc23352d6c16122268b6e Mon Sep 17 00:00:00 2001 From: casy Date: Thu, 2 Apr 2026 14:41:05 +0200 Subject: [PATCH] cleanup: remove unnecessary local deployment scripts - Remove docs-build.sh, docs-deploy.sh, docs-serve.sh (not needed for GitHub Actions) - Update .gitignore to exclude removed scripts - Update README to clarify automatic deployment - Simplify setup for GitHub Pages workflow --- .gitignore | 5 +++++ README.md | 14 +------------- docs-build.sh | 27 --------------------------- docs-deploy.sh | 41 ----------------------------------------- docs-serve.sh | 15 --------------- 5 files changed, 6 insertions(+), 96 deletions(-) delete mode 100755 docs-build.sh delete mode 100755 docs-deploy.sh delete mode 100755 docs-serve.sh diff --git a/.gitignore b/.gitignore index a0f62df..f356c35 100644 --- a/.gitignore +++ b/.gitignore @@ -121,3 +121,8 @@ ARCHITECTURE.md # MkDocs build output site/ + +# Local development scripts (not needed for GitHub Pages deployment) +docs-serve.sh +docs-deploy.sh +docs-build.sh diff --git a/README.md b/README.md index 31278b7..4ca611f 100644 --- a/README.md +++ b/README.md @@ -276,19 +276,7 @@ Our comprehensive documentation covers everything you need to know: This documentation is automatically deployed to GitHub Pages when you push to the `main` branch. -**To enable GitHub Pages:** -1. Go to your repository Settings → Pages -2. Source: Select "GitHub Actions" -3. The documentation will be available at: `https://digitaltouchcode.github.io/fisc/` - -**Manual deployment commands:** -```bash -# Build and deploy locally -./docs-deploy.sh - -# Or build only -./docs-build.sh -``` +**No local scripts needed** - GitHub Actions handles everything automatically! ### 📋 Documentation Contents diff --git a/docs-build.sh b/docs-build.sh deleted file mode 100755 index 82a27bf..0000000 --- a/docs-build.sh +++ /dev/null @@ -1,27 +0,0 @@ -#!/bin/bash - -# FiscGuy Documentation Build Script -# This script builds the documentation for deployment with Apple Pro fonts - -echo "Building FiscGuy Documentation..." -echo "Using Apple Pro fonts (SF Pro Display & SF Mono)" -echo "Output directory: site/" -echo "" - -# Activate virtual environment and build docs -source venv/bin/activate && mkdocs build - -if [ $? -eq 0 ]; then - echo "" - echo "Documentation built successfully!" - echo "Built files are in the 'site/' directory" - echo "Apple Pro fonts optimized for macOS" - echo "Ready to deploy to GitHub Pages or any static hosting" - echo "" - echo "To deploy to GitHub Pages:" - echo " mkdocs gh-deploy" -else - echo "" - echo "Build failed! Check the error messages above." - exit 1 -fi diff --git a/docs-deploy.sh b/docs-deploy.sh deleted file mode 100755 index 6ea2398..0000000 --- a/docs-deploy.sh +++ /dev/null @@ -1,41 +0,0 @@ -#!/bin/bash - -# FiscGuy Documentation Deployment Script -# Deploys documentation to GitHub Pages - -echo "Deploying FiscGuy Documentation to GitHub Pages..." -echo "Using Apple Pro fonts" -echo "" - -# Check if we're on the right branch -CURRENT_BRANCH=$(git branch --show-current) -if [ "$CURRENT_BRANCH" != "main" ]; then - echo " Warning: You're on branch '$CURRENT_BRANCH', not 'main'" - echo " Consider switching to main branch first" - echo "" -fi - -# Build the documentation -echo "📦 Building documentation..." -source venv/bin/activate && mkdocs build - -if [ $? -ne 0 ]; then - echo "Build failed! Please fix the errors above." - exit 1 -fi - -# Deploy to GitHub Pages -echo "Deploying to GitHub Pages..." -source venv/bin/activate && mkdocs gh-deploy --force - -if [ $? -eq 0 ]; then - echo "" - echo "Documentation deployed successfully!" - echo "Live at: https://digitaltouchcode.github.io/fisc/" - echo "" - echo "Note: It may take a few minutes for changes to appear." -else - echo "" - echo "Deployment failed! Check the error messages above." - exit 1 -fi diff --git a/docs-serve.sh b/docs-serve.sh deleted file mode 100755 index 6879295..0000000 --- a/docs-serve.sh +++ /dev/null @@ -1,15 +0,0 @@ -#!/bin/bash - -# FiscGuy Documentation Server -# This script starts the MkDocs development server with Apple Pro fonts - -echo "Starting FiscGuy Documentation Server..." -echo "Documentation will be available at: http://127.0.0.1:8001" -echo "Featuring Apple Pro fonts (SF Pro Display & SF Mono)" -echo "Auto-reload is enabled - changes will be reflected automatically" -echo "" -echo "To stop the server, press Ctrl+C" -echo "" - -# Activate virtual environment and serve docs -source venv/bin/activate && mkdocs serve --dev-addr=127.0.0.1:8001