feat: implement VuePress website with automated documentation sync and deployment#3
Open
bitsalv wants to merge 6 commits intoedge-mining:mainfrom
Open
feat: implement VuePress website with automated documentation sync and deployment#3bitsalv wants to merge 6 commits intoedge-mining:mainfrom
bitsalv wants to merge 6 commits intoedge-mining:mainfrom
Conversation
- 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
This was referenced Aug 31, 2025
Open
- 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
This was referenced Aug 31, 2025
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
🎯 Overview
This PR implements a complete VuePress website with automated documentation sync and deployment workflow, addressing issue #2.
✨ Features Implemented
🔄 Automated Documentation Sync
edge-mining/docs🎨 VuePress Website Foundation
📝 Developer-Focused README
🛠️ Workflow
📁 Key Changes
build-and-deploy.ymlfor automated deployment.vuepress/config.jssetup (foundation)⚙️ Setup Required
edgemining.energyEDGEMINING_ENERGY_TOKENsecret (from companion docs repo)🔗 Related
✅ Testing
This PR provides the foundation skeleton for the workflow proposed in #2. The VuePress setup is functional but requires further development:
This foundation enables immediate automated publishing while providing a solid base for future design and content improvements.