upd

Author: Smilefounder

.github/workflows/jekyll-gh-pages.yml

@@ -1,5 +1,5 @@
 # Sample workflow for building and deploying a Jekyll site to GitHub Pages
-name: Deploy Jekyll with GitHub Pages dependencies preinstalled
+name: Deploy Docusaurus to GitHub Pages
 
 on:
   # Runs on pushes targeting the default branch
@@ -22,24 +22,37 @@ concurrency:
   cancel-in-progress: false
 
 jobs:
-  # Build job
   build:
+    name: Build
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
         uses: actions/checkout@v4
-      - name: Setup Pages
-        uses: actions/configure-pages@v5
-      - name: Build with Jekyll
-        uses: actions/jekyll-build-pages@v1
+      
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
         with:
-          source: ./
-          destination: ./_site
+          node-version: 18
+          cache: 'npm'
+          cache-dependency-path: docs/package-lock.json
+      
+      - name: Install dependencies
+        run: |
+          cd docs
+          npm ci
+      
+      - name: Build website
+        run: |
+          cd docs
+          npm run build
+      
       - name: Upload artifact
         uses: actions/upload-pages-artifact@v3
+        with:
+          path: docs/build
 
-  # Deployment job
   deploy:
+    name: Deploy
     environment:
       name: github-pages
       url: ${{ steps.deployment.outputs.page_url }}

README.md

@@ -1,41 +1,101 @@
-# Website
+# Mixcore Documentation
 
-This website is built using [Docusaurus](https://docusaurus.io/), a modern static website generator.
+This repository contains the documentation for Mixcore CMS, built with [Docusaurus 3](https://docusaurus.io/).
+
+The live documentation is available at [docs.mixcore.org](https://docs.mixcore.org/).
+
+## Documentation Structure
+
+The documentation is organized by persona to make it easier for different users to find information relevant to their needs:
+
+- **Content Editors**: People who create and manage content
+- **Administrators**: System administrators who set up and maintain Mixcore
+- **Developers**: People who build applications and extend Mixcore
+- **Theme Designers**: People who create and customize visual themes
+- **DevOps Engineers**: People who deploy and maintain infrastructure
+
+## Local Development
+
+### Prerequisites
+
+- [Node.js](https://nodejs.org/en/) version 18 or above
+- npm or yarn
 
 ### Installation
 
-```
-$ yarn
-```
+```bash
+# Clone the repository
+git clone https://github.com/mixcore/mix.core.git
 
-### Local Development
+# Navigate to the docs directory
+cd mix.core/docs
 
+# Install dependencies
+npm install
 ```
-$ yarn start
+
+### Running Locally
+
+```bash
+# Start the development server
+npm start
 ```
 
-This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
+This command starts a local development server and opens a browser window. Most changes are reflected live without having to restart the server.
 
 ### Build
 
-```
-$ yarn build
+```bash
+# Generate static content
+npm run build
 ```
 
-This command generates static content into the `build` directory and can be served using any static contents hosting service.
+This command generates static content into the `build` directory and can be served using any static hosting service.
 
-### Deployment
+## Deployment
 
-Using SSH:
+The documentation is automatically deployed to GitHub Pages when changes are pushed to the master branch.
 
-```
-$ USE_SSH=true yarn deploy
-```
+### Manual Deployment
 
-Not using SSH:
+If you need to deploy manually, you can use the provided script:
 
+```bash
+# Make the script executable if needed
+chmod +x publish-gh-pages
+
+# Run the deployment script
+./publish-gh-pages
 ```
-$ GIT_USER=<Your GitHub username> yarn deploy
-```
 
-If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.
+### GitHub Actions
+
+Deployment is automated using GitHub Actions. The workflow configuration is located in `.github/workflows/deploy.yml`.
+
+## Contributing
+
+We welcome contributions to improve the documentation:
+
+1. **Fork** the repository
+2. Create a **branch** for your changes
+3. Make your changes
+4. Submit a **pull request**
+
+### Guidelines
+
+- Use clear, concise language
+- Provide examples where applicable
+- Keep each document focused on a specific topic
+- Follow the persona-based organization
+
+## License
+
+This documentation is licensed under the same license as Mixcore itself.
+
+## Contact
+
+For questions about the documentation, please:
+
+- Open an issue on [GitHub](https://github.com/mixcore/mix.core/issues)
+- Join the [Mixcore Discussions](https://github.com/orgs/mixcore/discussions)
+- Email us at [info@mixcore.org](mailto:info@mixcore.org)

docusaurus.config.ts

@@ -45,8 +45,7 @@ const config: Config = {
           showLastUpdateAuthor: true,
           showLastUpdateTime: true,
           // Please change this to your repo.
-          // Remove this to remove the "edit this page" links.
-          editUrl: 'https://github.com/mixcore/docs/tree/master',
+          editUrl: 'https://github.com/mixcore/mix.core/tree/master/docs',
         },
         theme: {
           customCss: './src/css/custom.css',

publish-gh-pages

@@ -1,2 +1,21 @@
 #!/bin/bash
-GIT_USER=Smilefounder   CURRENT_BRANCH=master   USE_SSH=true    yarn deploy
+
+# Script to deploy Mixcore docs to GitHub Pages
+echo "📚 Preparing to deploy Mixcore documentation..."
+
+# Clean any previous build
+echo "🧹 Cleaning previous build..."
+npm run clear
+
+# Build the Docusaurus site
+echo "🔨 Building the Docusaurus site..."
+npm run build
+
+# Deploy to GitHub Pages
+echo "🚀 Deploying to GitHub Pages..."
+GIT_USER=Smilefounder \
+  CURRENT_BRANCH=master \
+  USE_SSH=true \
+  npm run deploy
+
+echo "✅ Deployment complete! Your documentation is now live at https://docs.mixcore.org"