Skip to content

Conversation

@bitsalv
Copy link
Collaborator

@bitsalv bitsalv commented Aug 31, 2025

🎯 Overview

This PR implements a complete VuePress website with automated documentation sync and deployment workflow, addressing issue #2.

✨ Features Implemented

πŸ”„ Automated Documentation Sync

  • GitHub Actions workflow to automatically sync documentation from edge-mining/docs
  • Clean separation between content (docs repo) and website (this repo)
  • Auto-deployment to GitHub Pages on any changes

🎨 VuePress Website Foundation

  • Basic VuePress 2.0 setup with initial configuration
  • Skeleton structure ready for design and styling improvements
  • Foundation build process and deployment workflow

πŸ“ Developer-Focused README

  • Clear instructions for website development vs documentation editing
  • Proper workflow explanation for contributors
  • Local development setup and guidelines

πŸ› οΈ Workflow

Documentation Changes:
edge-mining/docs (FOR EDITORS)
    ↓ (Auto-sync)
edge-mining/edgemining.energy (FOR DEVELOPERS)
    ↓ (Auto-deploy)
Live Site (edgemining.energy)

πŸ“ Key Changes

  • πŸ†• GitHub Actions: build-and-deploy.yml for automated deployment
  • πŸ†• VuePress Config: Basic .vuepress/config.js setup (foundation)
  • πŸ“ README: Developer-focused documentation and workflow
  • 🎨 Basic Structure: Foundation ready for design and styling work
  • πŸ“š Documentation: Synced from documentation repository

βš™οΈ Setup Required

  1. GitHub Pages: Enable in repository settings
  2. Custom Domain: Configure edgemining.energy
  3. Documentation Sync: Set up EDGEMINING_ENERGY_TOKEN secret (from companion docs repo)

πŸ”— Related

βœ… Testing

  • VuePress builds successfully
  • GitHub Actions workflow validated
  • Documentation sync workflow need to be tested

⚠️ Note

This PR provides the foundation skeleton for the workflow proposed in #2. The VuePress setup is functional but requires further development:

  • Design & Styling: Current styling is minimal and needs visual improvements
  • Content: Documentation content is basic and requires review/enhancement
  • UX: User experience and navigation need refinement
  • Branding: Edge Mining visual identity needs to be properly implemented

This foundation enables immediate automated publishing while providing a solid base for future design and content improvements.

- Add VuePress 2 configuration with custom styling
- Add GitHub Actions build and deploy workflow
- Add Edge Mining brand colors and official logo
- Add responsive design for mobile and desktop
- Add custom domain edgemining.energy configuration
- Add complete documentation content structure
- Sync updated documentation from edgemining-docs
- Fix broken links and repository references
- Update README with repository information and development instructions
- Add modelling documentation structure
- Correct GitHub repository links
- Update README to be developer-focused with clear workflow
- Add specific guidance for developers vs editors
- Clarify repository relationships and contribution workflow
- Fix repository references to original edge-mining repositories
- Sync updated documentation from edgemining-docs
- Remove duplicate modelling files and clean structure
- Remove verbose content and redundant sections
- Match clean structure of edgemining-docs README
- Focus on essential information for developers
- Improve readability and professionalism
- Keep only relevant sections and guidelines
- Fix publish_dir from ./docs/.vuepress/dist to ./.vuepress/dist
- VuePress builds to .vuepress/dist/ not docs/.vuepress/dist/
- This ensures GitHub Pages deployment works correctly
- Remove .vuepress/.temp/ and .vuepress/.cache/ from repository
- Add proper .gitignore rules for VuePress build files
- These files should never be committed to version control
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Proposal: Automating Documentation Publishing w/ GitHub Actions

1 participant