Merge pull request #8 from ml-comm/ci/docs

ci/docs

.github/workflows/docs.yml

@@ -0,0 +1,61 @@
+name: Publish Vitepess Docs
+
+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 job
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0 # Not needed if lastUpdated is not enabled
+      - uses: pnpm/action-setup@v3 # Uncomment this block if you're using pnpm
+        with:
+          version: 9 # Not needed if you've set "packageManager" in package.json
+      - name: Setup Node
+        uses: actions/setup-node@v4
+        with:
+          node-version: 20
+          cache: pnpm
+      - name: Setup Pages
+        uses: actions/configure-pages@v4
+      - name: Install dependencies
+        run: pnpm install
+      - name: Build with VitePress
+        run: pnpm docs:build
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: docs/.vitepress/dist
+
+  # Deployment job
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    needs: build
+    runs-on: ubuntu-latest
+    name: Deploy
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

docs/.gitignore

@@ -0,0 +1,132 @@
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+lerna-debug.log*
+.pnpm-debug.log*
+
+# Diagnostic reports (https://nodejs.org/api/report.html)
+report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
+
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+*.lcov
+
+# nyc test coverage
+.nyc_output
+
+# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# Bower dependency directory (https://bower.io/)
+bower_components
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (https://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directories
+node_modules/
+jspm_packages/
+
+# Snowpack dependency directory (https://snowpack.dev/)
+web_modules/
+
+# TypeScript cache
+*.tsbuildinfo
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Optional stylelint cache
+.stylelintcache
+
+# Microbundle cache
+.rpt2_cache/
+.rts2_cache_cjs/
+.rts2_cache_es/
+.rts2_cache_umd/
+
+# Optional REPL history
+.node_repl_history
+
+# Output of 'npm pack'
+*.tgz
+
+# Yarn Integrity file
+.yarn-integrity
+
+# dotenv environment variable files
+.env
+.env.development.local
+.env.test.local
+.env.production.local
+.env.local
+
+# parcel-bundler cache (https://parceljs.org/)
+.cache
+.parcel-cache
+
+# Next.js build output
+.next
+out
+
+# Nuxt.js build / generate output
+.nuxt
+dist
+
+# Gatsby files
+.cache/
+# Comment in the public line in if your project uses Gatsby and not Next.js
+# https://nextjs.org/blog/next-9-1#public-directory-support
+# public
+
+# vuepress build output
+.vuepress/dist
+
+# vuepress v2.x temp and cache directory
+.temp
+.cache
+
+# Docusaurus cache and generated files
+.docusaurus
+
+# Serverless directories
+.serverless/
+
+# FuseBox cache
+.fusebox/
+
+# DynamoDB Local files
+.dynamodb/
+
+# TernJS port file
+.tern-port
+
+# Stores VSCode versions used for testing VSCode extensions
+.vscode-test
+
+# yarn v2
+.yarn/cache
+.yarn/unplugged
+.yarn/build-state.yml
+.yarn/install-state.gz
+.pnp.*
+
+.vitepress/cache

docs/.vitepress/config.mts

@@ -0,0 +1,30 @@
+import { defineConfig } from 'vitepress'
+
+// https://vitepress.dev/reference/site-config
+export default defineConfig({
+  title: "DDNS",
+  description: "A free subdomain provider for the Machine Learning community ",
+  themeConfig: {
+    // https://vitepress.dev/reference/default-theme-config
+    nav: [
+      { text: 'Home', link: '/' },
+      { text: 'Docs', link: '/getting-started' },
+    ],
+
+    logo: "https://github.com/ML-comm.png",
+
+    sidebar: [
+      {
+        text: 'Docs',
+        items: [
+          { text: 'Getting Started', link: '/getting-started' },
+          { text: 'Format', link: '/format' }
+        ]
+      }
+    ],
+
+    socialLinks: [
+      { icon: 'github', link: 'https://github.com/vuejs/vitepress' }
+    ]
+  }
+})

docs/FORMAT.md → docs/format.md

@@ -1,9 +1,7 @@
 ---
-layout: default
-title: Format types
-nav_order: 2
+outline: deep
 ---
-# Formats
+# Formats <Badge type="danger" text="DNS" />
 
 Following the specific JSON format is important as it allows us to easily process your domain without any issues. If the correct format is not followed, you will be told and the pull request will **not** be merged. 
 

docs/getting-started.md

@@ -0,0 +1,30 @@
+# Getting Started: Claim you Subdomain <Badge type="tip" text="guide" />
+
+This guide explains how to get a free `*.mlcommunity.dev` subdomain for your machine learning, data science, AI, or research project.
+
+**Steps:**
+
+1. **Fork the Repository:** Fork the [ddns repository](https://github.com/ml-comm/ddns/fork) to your GitHub account. This creates a copy you can edit.
+
+2. **Create a Configuration File:**
+   - In your forked repository, create a new JSON file inside the `domains` directory.
+   - Name the file after your desired subdomain (e.g., `my-project.json` for `my-project.mlcommunity.dev`).  The full path would be `domains/my-project.json`.
+   - **Important:**  See the [format documentation](FORMAT.md) for the required JSON structure.  Double-check your file for accuracy.
+
+3. **Request Your Subdomain:** Open an issue on the main ddns repository using the [request template](https://github.com/ml-comm/ddns/issues/new?assignees=&labels=request&projects=&template=REQUEST.yml&title=%5BREQUEST%5D%3A+).  Discuss your desired subdomain and any specific needs.  This allows us to review and approve your request.
+
+4. **Submit a Pull Request:** Once your request is approved, create a pull request from your forked repository to the main `ddns` repository, including your newly created JSON file.
+
+5. **Review and Adjustments:**  We may review your pull request and leave comments or labels if there are any issues (e.g., unavailable subdomain, formatting problems).  Please address these and update your pull request as needed.
+
+6. **Subdomain Activation:**  We'll merge your pull request once everything is in order and activate your subdomain.
+
+7. **Managing Your Subdomain:** You can update your subdomain settings at any time by submitting a new pull request with the modified JSON file.
+
+
+## Important Considerations:
+
+* **Valid Records:**  Only permitted record types are allowed. We'll notify you if there are issues.
+* **Acceptable Use:** Subdomains must be related to machine learning, data science, AI, or research and cannot violate privacy, serve malicious content, or be used for illegal activities.
+* **Inactivity:** Inactive subdomains may be purged. We'll attempt to notify you via the email you provided before purging.
+* **Denied Requests:** We reserve the right to deny subdomain requests that don't meet these criteria.

docs/index.md

@@ -1,36 +1,28 @@
 ---
-layout: default
-title: Getting Started
-nav_order: 1
+# https://vitepress.dev/reference/default-theme-home-page
+layout: home
+
+hero:
+  name: "DDNS"
+  text: "A free subdomain provider for the Machine Learning community "
+  tagline: "🚀"
+  image:
+      src: "https://github.com/ML-comm.png"
+      alt: "Hero Image"
+  actions:
+    - theme: brand
+      text: Get Started
+      link: /getting-started
+    - theme: alt
+      text: Format
+      link: /format
+
+features:
+  - title: "Free Subdomain"
+    details: "Get a free `*.mlcommunity.dev` subdomain for your machine learning, data science, AI, or research project."
+  - title: "Easy Setup"
+    details: "Fork the repository, create a configuration file, and submit a pull request. We'll take care of the rest."
+  - title: "Community Driven"
+    details: "We're here to help you get your project online."
 ---
 
-## Getting Started: Your Free Subdomain
-
-This guide explains how to get a free `*.ml-comm.ml` subdomain for your machine learning, data science, AI, or research project.
-
-**Steps:**
-
-1. **Fork the Repository:** Fork the [ddns repository](https://github.com/ml-comm/ddns/fork) to your GitHub account. This creates a copy you can edit.
-
-2. **Create a Configuration File:**
-   - In your forked repository, create a new JSON file inside the `domains` directory.
-   - Name the file after your desired subdomain (e.g., `my-project.json` for `my-project.ml-comm.ml`).  The full path would be `domains/my-project.json`.
-   - **Important:**  See the [format documentation](FORMAT.md) for the required JSON structure.  Double-check your file for accuracy.
-
-3. **Request Your Subdomain:** Open an issue on the main ddns repository using the [request template](https://github.com/ml-comm/ddns/issues/new?assignees=&labels=request&projects=&template=REQUEST.yml&title=%5BREQUEST%5D%3A+).  Discuss your desired subdomain and any specific needs.  This allows us to review and approve your request.
-
-4. **Submit a Pull Request:** Once your request is approved, create a pull request from your forked repository to the main `ddns` repository, including your newly created JSON file.
-
-5. **Review and Adjustments:**  We may review your pull request and leave comments or labels if there are any issues (e.g., unavailable subdomain, formatting problems).  Please address these and update your pull request as needed.
-
-6. **Subdomain Activation:**  We'll merge your pull request once everything is in order and activate your subdomain.
-
-7. **Managing Your Subdomain:** You can update your subdomain settings at any time by submitting a new pull request with the modified JSON file.
-
-
-## Important Considerations:
-
-* **Valid Records:**  Only permitted record types are allowed. We'll notify you if there are issues.
-* **Acceptable Use:** Subdomains must be related to machine learning, data science, AI, or research and cannot violate privacy, serve malicious content, or be used for illegal activities.
-* **Inactivity:** Inactive subdomains may be purged. We'll attempt to notify you via the email you provided before purging.
-* **Denied Requests:** We reserve the right to deny subdomain requests that don't meet these criteria.

docs/package.json

@@ -0,0 +1,13 @@
+{
+  "name": "docs",
+  "version": "0.0.0",
+  "scripts": {
+    "docs:dev": "vitepress dev",
+    "docs:build": "vitepress build",
+    "docs:preview": "vitepress preview"
+  },
+  "packageManager": "[email protected]",
+  "devDependencies": {
+    "vitepress": "^1.5.0"
+  }
+}