Move documentation from separate branch to main branch (#156)

* feat: migrate documentation from separate branch to main

- Move Docusaurus site from documentation branch to docs/ directory
- Separate folder to main library to resolve React 16/18 version conflicts
- Add docs:* scripts to root package.json for documentation commands
- Update GitHub Actions workflows for main branch deployment
- Preserve all existing CI/CD functionality for library packages

Author: marlonicus

.github/workflows/check-documentation.yml

@@ -0,0 +1,31 @@
+name: Check Documentation
+
+on:
+  push:
+    branches:
+      - main
+    paths:
+      - 'docs/**'
+  pull_request:
+    types: [opened, synchronize, reopened]
+    paths:
+      - 'docs/**'
+
+jobs:
+  check_docs:
+    runs-on: ubuntu-latest
+    name: Typecheck and Build Documentation
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          submodules: true
+      - name: Set up Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version-file: '.nvmrc'
+          cache: 'yarn'
+          cache-dependency-path: docs/yarn.lock
+      - name: Install dependencies
+        run: cd docs && yarn install --immutable
+      - name: Build documentation
+        run: cd docs && CI=true yarn build

.github/workflows/deploy-documentation.yml

@@ -0,0 +1,48 @@
+name: GitHub Pages Deploy
+
+on:
+  push:
+    branches:
+      - main
+    paths:
+      - 'docs/**'
+  workflow_dispatch:
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
+# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
+
+jobs:
+  build_and_deploy:
+    runs-on: ubuntu-latest
+    name: Build and Deploy Documentation to GitHub Pages
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          submodules: true
+      - name: Set up Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version-file: '.nvmrc'
+          cache: 'yarn'
+          cache-dependency-path: docs/yarn.lock
+      - name: Install dependencies
+        run: cd docs && yarn install --immutable
+      - name: Build documentation
+        run: cd docs && yarn build
+      - name: Setup Pages
+        uses: actions/configure-pages@v5
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: './docs/build'
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

README.md

@@ -28,7 +28,15 @@ Ore UI is based on:
 
 We currently only have one package that is open-source, and its documentation is available at https://react-facet.mojang.com/.
 
-The source of the documentation (for contributions) is available at the [documentation branch](https://github.com/Mojang/ore-ui/tree/documentation).
+The source of the documentation is available in the [`docs/`](docs/) directory. To contribute to the documentation:
+
+```bash
+# Install and start the documentation site
+yarn docs:install
+yarn docs:start
+```
+
+For more details, see the [documentation README](docs/README.md).
 
 ## Logo
 

docs/.eslintrc.js

@@ -0,0 +1,45 @@
+/* eslint-env node */
+
+module.exports = {
+  env: {
+    node: true,
+    es6: true,
+  },
+  extends: ['plugin:prettier/recommended'],
+  plugins: ['prettier'],
+  rules: {
+    'prettier/prettier': [
+      'error',
+      {
+        endOfLine: 'auto',
+      },
+    ],
+    // Disable the require-in-package rule that's problematic for Docusaurus
+    'require-in-package/require-in-package': 'off',
+  },
+  overrides: [
+    {
+      // For React components in the docs (like homepage components)
+      files: ['src/**/*.{js,jsx}'],
+      env: {
+        browser: true,
+        es6: true,
+      },
+      plugins: ['react', 'prettier'],
+      rules: {
+        'react/jsx-uses-react': 'error',
+        'react/jsx-uses-vars': 'error',
+        'prettier/prettier': [
+          'error',
+          {
+            endOfLine: 'auto',
+          },
+        ],
+        // Disable problematic import rules for Docusaurus
+        'import/no-unresolved': 'off',
+        'import/no-named-as-default': 'off',
+        'require-in-package/require-in-package': 'off',
+      },
+    },
+  ],
+}

docs/.gitignore

@@ -0,0 +1,21 @@
+# Dependencies
+/node_modules
+
+# Production
+/build
+
+# Generated files
+.yarn
+.docusaurus
+.cache-loader
+
+# Misc
+.DS_Store
+.env.local
+.env.development.local
+.env.test.local
+.env.production.local
+
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*

docs/.prettierignore

@@ -0,0 +1,9 @@
+.vscode/
+node_modules/
+.yarn/
+.pnp.*
+docs/build
+docs/.docusaurus
+coverage
+**/dist/
+build

docs/.prettierrc

@@ -0,0 +1,8 @@
+{
+  "printWidth": 120,
+  "useTabs": false,
+  "semi": false,
+  "singleQuote": true,
+  "trailingComma": "all",
+  "endOfLine": "auto"
+}

docs/README.md

@@ -0,0 +1,55 @@
+# Documentation
+
+This directory contains the Docusaurus-based documentation website for ore-ui.
+
+This website is built using [Docusaurus 2](https://docusaurus.io/), a modern static website generator.
+
+## Development
+
+### Prerequisites
+
+The documentation site uses React 16 (required by Docusaurus 2.4.3), which is different from the main project's React 18. This is why the documentation is kept as a separate workspace with its own dependencies.
+
+### Getting Started
+
+```console
+# From project root
+yarn docs:install && yarn docs:start
+
+# Or from docs directory
+cd docs && yarn install && yarn 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.
+
+### Build
+
+```console
+# From project root
+yarn docs:build
+
+# Or from docs directory
+cd docs && yarn build
+```
+
+This command generates static content into the `build` directory and can be served using any static contents hosting service.
+
+### Deployment
+
+The documentation is automatically deployed to GitHub Pages when changes are pushed to the `docs/` directory on the main branch.
+
+### Architecture
+
+- **Framework**: Docusaurus 2.4.3
+- **React Version**: 16.9.0 (required by Docusaurus)
+- **Deployment**: GitHub Pages
+- **Build Output**: `docs/build/`
+
+### Separate Workspace Rationale
+
+The documentation is maintained as a separate workspace (not included in the main yarn workspaces) because:
+
+1. **React Version Conflict**: Main project uses React 18, while Docusaurus requires React 16
+2. **Independent Dependencies**: Documentation has different tooling and build requirements
+3. **Separate Build Pipeline**: Different CI/CD requirements for documentation vs library packages
+4. **Deployment Independence**: Documentation can be deployed separately from library releases

docs/babel.config.js

@@ -0,0 +1,3 @@
+module.exports = {
+  presets: [require.resolve('@docusaurus/core/lib/babel/preset')],
+}

docs/blog/2019-05-28-hola.md

@@ -0,0 +1,11 @@
+---
+slug: hola
+title: Hola
+author: Gao Wei
+author_title: Docusaurus Core Team
+author_url: https://github.com/wgao19
+author_image_url: https://avatars1.githubusercontent.com/u/2055384?v=4
+tags: [hola, docusaurus]
+---
+
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet