LGS Forge Documentation

Comprehensive help documentation for the LGS Forge Shopify app.

Overview

This documentation is designed to help merchants get the most out of LGS Forge, a Shopify app for syncing Magic: The Gathering products with automated pricing and inventory management.

Documentation Structure

docs/
├── index.md                  # Documentation home (docs.lgsforge.com)
├── homepage.md               # Marketing homepage (www.lgsforge.com)
├── README.md                 # This file (deployment instructions)
│
└── guides/
    ├── getting-started.md    # Installation and first-time setup
    ├── connecting-store.md   # Connecting Shopify stores
    ├── syncing-products.md   # Product sync process
    ├── pricing-config.md     # Pricing configuration
    ├── settings-metafields.md # Metafield setup and configuration
    ├── catalog.md            # Browsing the MTG catalog
    ├── sync-history.md       # Reviewing past syncs
    ├── price-sync-schedule.md # Automated price updates
    ├── multi-store.md        # Multi-store management
    ├── best-practices.md     # Recommended strategies
    ├── deleting-products.md  # Product deletion guide
    ├── troubleshooting.md    # Common issues and solutions
    └── faq.md                # Frequently asked questions

Site Structure

LGS Forge uses three domains:

www.lgsforge.com - Marketing homepage (homepage.md)
docs.lgsforge.com - Documentation site (index.md + guides)
app.lgsforge.com - Application (main app)

Deployment Options

Option 1: VitePress (Recommended)

VitePress is a modern static site generator built on Vite. Great for technical documentation.

Setup

bash

# Install VitePress
npm install -D vitepress

# Initialize VitePress config
npx vitepress init

Configuration

Create .vitepress/config.js:

javascript

export default {
  title: 'LGS Forge Documentation',
  description: 'Help documentation for the LGS Forge Shopify app',
  base: '/',

  themeConfig: {
    nav: [
      { text: 'Home', link: '/' },
      { text: 'Getting Started', link: '/guides/getting-started' },
      { text: 'App', link: 'https://app.lgsforge.com' }
    ],

    sidebar: [
      {
        text: 'Getting Started',
        items: [
          { text: 'Introduction', link: '/guides/getting-started' },
          { text: 'Connecting Your Store', link: '/guides/connecting-store' },
          { text: 'Syncing Products', link: '/guides/syncing-products' }
        ]
      },
      {
        text: 'Configuration',
        items: [
          { text: 'Pricing Configuration', link: '/guides/pricing-config' },
          { text: 'Settings & Metafields', link: '/guides/settings-metafields' },
          { text: 'Price Sync Scheduling', link: '/guides/price-sync-schedule' }
        ]
      },
      {
        text: 'Features',
        items: [
          { text: 'Browsing the Catalog', link: '/guides/catalog' },
          { text: 'Sync History', link: '/guides/sync-history' },
          { text: 'Multi-Store Management', link: '/guides/multi-store' },
          { text: 'Deleting Products', link: '/guides/deleting-products' }
        ]
      },
      {
        text: 'Resources',
        items: [
          { text: 'Best Practices', link: '/guides/best-practices' },
          { text: 'Troubleshooting', link: '/guides/troubleshooting' },
          { text: 'FAQ', link: '/guides/faq' }
        ]
      }
    ],

    socialLinks: [
      { icon: 'github', link: 'https://github.com/ufkesba/lgs-ledger' }
    ],

    footer: {
      message: 'Released under the MIT License.',
      copyright: 'Copyright © 2026 LGS Forge'
    }
  }
}

Build and Deploy

bash

# Build static site
npx vitepress build docs

# Output is in docs/.vitepress/dist/
# Deploy to docs.lgsledger.com

Option 2: MkDocs

Python-based documentation generator. Simple and effective.

Setup

bash

# Install MkDocs
pip install mkdocs mkdocs-material

# Initialize
mkdocs new lgs-ledger-docs

Configuration

Create mkdocs.yml:

yaml

site_name: LGS Forge Documentation
site_url: https://docs.lgsforge.com
theme:
  name: material
  palette:
    primary: indigo
    accent: blue
  features:
    - navigation.tabs
    - navigation.sections
    - toc.integrate

nav:
  - Home: index.md
  - Getting Started:
    - Introduction: guides/getting-started.md
    - Connecting Your Store: guides/connecting-store.md
    - Syncing Products: guides/syncing-products.md
  - Configuration:
    - Pricing Configuration: guides/pricing-config.md
    - Settings & Metafields: guides/settings-metafields.md
    - Price Sync Scheduling: guides/price-sync-schedule.md
  - Features:
    - Browsing the Catalog: guides/catalog.md
    - Sync History: guides/sync-history.md
    - Multi-Store Management: guides/multi-store.md
    - Deleting Products: guides/deleting-products.md
  - Resources:
    - Best Practices: guides/best-practices.md
    - Troubleshooting: guides/troubleshooting.md
    - FAQ: guides/faq.md

Build and Deploy

bash

# Build
mkdocs build

# Output is in site/
# Deploy to docs.lgsledger.com

Option 3: Docusaurus

React-based documentation framework by Facebook. Feature-rich.

Setup

bash

# Create Docusaurus site
npx create-docusaurus@latest lgs-docs classic

# Move markdown files to docs/ directory
cp -r guides lgs-docs/docs/

Configuration

Edit docusaurus.config.js:

javascript

module.exports = {
  title: 'LGS Forge Documentation',
  tagline: 'Shopify app for MTG product management',
  url: 'https://docs.lgsforge.com',
  baseUrl: '/',
  onBrokenLinks: 'throw',
  favicon: 'img/favicon.ico',

  themeConfig: {
    navbar: {
      title: 'LGS Forge',
      items: [
        {
          type: 'doc',
          docId: 'guides/getting-started',
          position: 'left',
          label: 'Documentation',
        },
        {
          href: 'https://app.lgsforge.com',
          label: 'App',
          position: 'right',
        },
        {
          href: 'https://github.com/ufkesba/lgs-ledger',
          label: 'GitHub',
          position: 'right',
        },
      ],
    },

    footer: {
      style: 'dark',
      links: [
        {
          title: 'Docs',
          items: [
            { label: 'Getting Started', to: '/docs/guides/getting-started' },
            { label: 'Troubleshooting', to: '/docs/guides/troubleshooting' },
          ],
        },
        {
          title: 'More',
          items: [
            { label: 'GitHub', href: 'https://github.com/ufkesba/lgs-ledger' },
          ],
        },
      ],
      copyright: `Copyright © ${new Date().getFullYear()} LGS Forge.`,
    },
  },
};

Build and Deploy

bash

# Build
npm run build

# Output is in build/
# Deploy to docs.lgsledger.com

Option 4: GitHub Pages (Simple)

Host directly from the GitHub repo using GitHub Pages.

Setup

Push docs to GitHub:

bash

git add docs/
git commit -m "Add documentation"
git push origin main

Enable GitHub Pages:
- Go to repo Settings → Pages
- Source: Deploy from a branch
- Branch: main → /docs
- Save
Custom domain:
- Add CNAME file to docs/ with content: docs.lgsforge.com
- Configure DNS: Add CNAME record pointing to <username>.github.io
Access at: https://docs.lgsforge.com

Note: GitHub Pages renders markdown automatically, but lacks advanced features (search, theming, etc.).

Option 5: Vercel/Netlify (Recommended for VitePress/Docusaurus)

Deploy static sites easily with CI/CD.

Vercel

bash

# Install Vercel CLI
npm i -g vercel

# Deploy
vercel --prod

# Configure custom domain: docs.lgsledger.com

Netlify

bash

# Install Netlify CLI
npm i -g netlify-cli

# Deploy
netlify deploy --prod

# Configure custom domain: docs.lgsledger.com

Both platforms auto-deploy on git push.

Marketing Homepage Deployment

Deploy homepage.md to www.lgsforge.com (or lgsforge.com):

Option 1: Convert to HTML

Use Pandoc or a static site generator:

bash

# Convert homepage.md to HTML
pandoc homepage.md -o index.html --standalone --css=style.css

Deploy index.html to your web server.

Option 2: Use Same Static Site Generator

Build homepage.md as the landing page using VitePress/Docusaurus/MkDocs and deploy to lgsforge.com.

DNS Configuration

Set up DNS for all three domains:

www.lgsforge.com (Marketing)

A record:
  Name: @
  Value: <your-server-ip> or <hosting-provider-ip>

CNAME record:
  Name: www
  Value: <your-server> or <hosting-provider>

docs.lgsforge.com (Documentation)

CNAME record:
  Name: docs
  Value: <docs-host> (e.g., your-vitepress.vercel.app)

app.lgsforge.com (Application)

CNAME record:
  Name: app
  Value: <your-app-server> (e.g., your-app.firebase.app)

Recommended Deployment Stack

For docs.lgsforge.com:

Generator: VitePress (modern, fast, clean)
Hosting: Vercel or Netlify (auto-deploy on push)
CI/CD: GitHub Actions (optional, for custom builds)

For www.lgsforge.com:

Framework: Custom HTML/CSS or React landing page
Hosting: Vercel/Netlify/Firebase
Analytics: Google Analytics, Plausible, or Fathom

For app.lgsforge.com:

Already deployed (existing app infrastructure)

Maintenance

Updating Documentation

Edit markdown files in docs/guides/
Commit and push to GitHub
Static site auto-deploys (if using Vercel/Netlify)
Or manually rebuild and deploy

Adding New Guides

Create new .md file in docs/guides/
Update sidebar config in .vitepress/config.js or mkdocs.yml
Add internal links from index.md or other guides
Rebuild and deploy

Versioning

Consider versioning docs for major app updates:

VitePress example:

javascript

themeConfig: {
  sidebar: {
    '/v1/': [...],  // v1 docs
    '/v2/': [...],  // v2 docs
  }
}

SEO Optimization

Meta Tags

Add to .vitepress/config.js:

javascript

head: [
  ['meta', { name: 'description', content: 'LGS Forge - Shopify app for MTG product management' }],
  ['meta', { name: 'keywords', content: 'MTG, Magic: The Gathering, Shopify, LGS, inventory management' }],
  ['meta', { property: 'og:title', content: 'LGS Forge Documentation' }],
  ['meta', { property: 'og:description', content: 'Help documentation for LGS Forge' }],
  ['meta', { property: 'og:image', content: '/og-image.png' }],
]

Sitemap

VitePress/Docusaurus/MkDocs auto-generate sitemaps. Submit to Google Search Console:

https://docs.lgsforge.com/sitemap.xml

Analytics

Track documentation usage:

Google Analytics

Add to .vitepress/config.js:

javascript

head: [
  ['script', { async: true, src: 'https://www.googletagmanager.com/gtag/js?id=G-XXXXXXXXXX' }],
  ['script', {}, `
    window.dataLayer = window.dataLayer || [];
    function gtag(){dataLayer.push(arguments);}
    gtag('js', new Date());
    gtag('config', 'G-XXXXXXXXXX');
  `]
]

Plausible (Privacy-Friendly)

javascript

head: [
  ['script', { defer: true, 'data-domain': 'docs.lgsforge.com', src: 'https://plausible.io/js/script.js' }]
]

Support

For questions about documentation deployment:

GitHub Issues: Report documentation issues
VitePress Docs: https://vitepress.dev
MkDocs Docs: https://www.mkdocs.org
Docusaurus Docs: https://docusaurus.io

License

Documentation is licensed under MIT License. See LICENSE in the repo root.

Last Updated: January 2026 Maintainer: LGS Forge Team

LGS Forge Documentation ​

Overview ​

Documentation Structure ​

Site Structure ​

Deployment Options ​

Option 1: VitePress (Recommended) ​

Setup ​

Configuration ​

Build and Deploy ​

Option 2: MkDocs ​

Setup ​

Configuration ​

Build and Deploy ​

Option 3: Docusaurus ​

Setup ​

Configuration ​

Build and Deploy ​

Option 4: GitHub Pages (Simple) ​

Setup ​

Option 5: Vercel/Netlify (Recommended for VitePress/Docusaurus) ​

Vercel ​

Netlify ​

Marketing Homepage Deployment ​

Option 1: Convert to HTML ​

Option 2: Use Same Static Site Generator ​

DNS Configuration ​

www.lgsforge.com (Marketing) ​

docs.lgsforge.com (Documentation) ​

app.lgsforge.com (Application) ​

Recommended Deployment Stack ​

Maintenance ​

Updating Documentation ​

Adding New Guides ​

Versioning ​

SEO Optimization ​

Meta Tags ​

Sitemap ​

Analytics ​

Google Analytics ​

Plausible (Privacy-Friendly) ​

Support ​

License ​

LGS Forge Documentation

Overview

Documentation Structure

Site Structure

Deployment Options

Option 1: VitePress (Recommended)

Setup

Configuration

Build and Deploy

Option 2: MkDocs

Setup

Configuration

Build and Deploy

Option 3: Docusaurus

Setup

Configuration

Build and Deploy

Option 4: GitHub Pages (Simple)

Setup

Option 5: Vercel/Netlify (Recommended for VitePress/Docusaurus)

Vercel

Netlify

Marketing Homepage Deployment

Option 1: Convert to HTML

Option 2: Use Same Static Site Generator

DNS Configuration

www.lgsforge.com (Marketing)

docs.lgsforge.com (Documentation)

app.lgsforge.com (Application)

Recommended Deployment Stack

Maintenance

Updating Documentation

Adding New Guides

Versioning

SEO Optimization

Meta Tags

Sitemap

Analytics

Google Analytics

Plausible (Privacy-Friendly)

Support

License