pull everying in site up a level, flattening the repo structure

Author: heskew

.github/workflows/deploy.yaml

@@ -31,25 +31,10 @@ jobs:
           cache: 'npm'
           cache-dependency-path: 'package-lock.json'
 
-      - name: Debug - Show directory structure
+      - name: Install dependencies
         run: |
-          echo "Current directory: $(pwd)"
-          echo "Repository root contents:"
-          ls -la
-          echo "Site directory contents:"
-          ls -la site/ || echo "Site directory not found"
-          echo "Looking for package.json files:"
-          find . -name "package.json" -type f
-
-      - name: Install root dependencies
-        run: |
-          echo "Installing root dependencies from $(pwd)"
-          npm ci || (echo "Root npm ci failed, uploading logs" && exit 1)
-
-      - name: Install site dependencies
-        run: |
-          echo "Installing site dependencies..."
-          npm run site:install || (echo "Site install failed" && exit 1)
+          echo "Installing dependencies from $(pwd)"
+          npm ci || (echo "npm ci failed, uploading logs" && exit 1)
 
       - name: Build Docusaurus site
         env:
@@ -63,7 +48,7 @@ jobs:
           echo "Using DOCUSAURUS_BASE_URL: $DOCUSAURUS_BASE_URL"
           echo "Using DOCUSAURUS_URL: $DOCUSAURUS_URL"
           echo "Using IMAGES_PATH: $IMAGES_PATH"
-          npm run site:build || (echo "Site build failed" && exit 1)
+          npm run build || (echo "Site build failed" && exit 1)
 
       - name: Upload npm logs on failure
         if: failure()
@@ -76,7 +61,7 @@ jobs:
       - name: Upload Build Artifact
         uses: actions/upload-pages-artifact@v3
         with:
-          path: site/build
+          path: build
 
   deploy:
     needs: build

.gitignore

@@ -1,50 +1,36 @@
-# Build and Release Folders
-bin-debug/
-bin-release/
-[Oo]bj/
-[Bb]in/
+# Dependencies
+node_modules
 
-# Other files and folders
-.settings/
+# Production
+build
+
+# Generated files
+.docusaurus
+.cache-loader
 
-# Executables
-*.swf
-*.air
-*.ipa
-*.apk
+# Root index page is conditionally generated if docs is not at the root
+/src/pages/index.tsx
 
-# Project files, i.e. `.project`, `.actionScriptProperties` and `.flexProperties`
-# should NOT be excluded as they contain compiler settings and other important
-# information for Eclipse / Flash Builder.
+# Misc
 .DS_Store
+.env.local
+.env.development.local
+.env.test.local
+.env.production.local
+
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+
+# IDE
 .idea/workspace.xml
 .idea/documentation.iml
 .idea/modules.xml
 .idea/vcs.xml
+.settings/
 
-node_modules
-
-# Site .gitignore so its picked up by prettier
-# Dependencies
-site/node_modules
-
-# Production
-site/build
-
-# Latest (/docs/) is a build time copy of the latest version
-site/docs
-
-# Generated files
-site/.docusaurus
-site/.cache-loader
+# OS files
+Thumbs.db
 
-# Misc
-site/.DS_Store
-site/.env.local
-site/.env.development.local
-site/.env.test.local
-site/.env.production.local
-
-site/npm-debug.log*
-site/yarn-debug.log*
-site/yarn-error.log*
+# Old site directory (cleanup)
+site/

README.md

@@ -11,3 +11,83 @@ This documentation site is open source!
 If you notice something out-of-place or have suggestions for improvement, please feel free to submit an issue and/or a pull request. Make sure to follow the relevant bug report and content/feature request templates.
 
 For more information on contributing, follow the [contribution guide](CONTRIBUTING.md).
+
+## 🚀 Quick Start
+
+```bash
+# Install dependencies
+npm install
+
+# Start development server
+npm start
+# Opens at http://localhost:3000
+
+# Build for production
+npm run build
+
+# Serve production build locally
+npm run serve
+```
+
+## 📁 Directory Structure
+
+```text
+├── docs/                # Main documentation content
+├── images/              # Images for documentation
+├── static/              # Static assets
+│   ├── img/             # Site images and logos
+│   └── js/              # JavaScript files
+├── src/                 # React components and custom pages
+│   ├── css/             # Custom styles
+│   └── pages/           # Custom pages
+├── versioned_docs/      # Documentation for previous versions
+├── versioned_sidebars/  # Sidebar configurations for versions
+├── docusaurus.config.ts # Main Docusaurus configuration
+├── sidebars.ts          # Sidebar navigation structure
+├── redirects.ts         # URL redirects configuration
+└── versions.json        # Version configuration
+```
+
+## 🛠️ Development
+
+### Running Locally
+
+```bash
+# Start the development server with hot reload
+npm start
+
+# Clear cache if you encounter issues
+npm run clear
+```
+
+The development server runs at `http://localhost:3000` and automatically reloads when you make changes.
+
+### Other Commands
+
+```bash
+# Type checking
+npm run typecheck
+
+# Format code
+npm run format
+
+# Clean all generated files and caches
+npm run clear
+```
+
+## 📋 Cutting a New Version
+
+When releasing a new version of Harper documentation:
+
+```bash
+# Cut a new version (e.g., 4.7)
+npm run version
+```
+
+This will:
+
+1. Copy current docs to versioned_docs/version-4.7
+2. Copy current sidebars to versioned_sidebars
+3. Update versions.json
+
+After cutting a version, update `docusaurus.config.ts` to set the new `lastVersion`.