isolated-local-llm-deployment-monitoring-stack

LLM Stack Documentation Site

This directory contains the React-based documentation site for the Isolated Local LLM Deployment & Monitoring Stack, built with Docusaurus.

🚀 Quick Start

Installation

cd docs
npm install

Local Development

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.

Build

npm run build

This command generates static content into the build directory and can be served using any static contents hosting service.

📁 Project Structure

docs/
├── blog/                   # Blog posts
│   ├── 2024-01-01-welcome.md
│   └── authors.yml
├── docs/                   # Documentation pages
│   ├── intro.md           # Getting Started
│   ├── llm-deployment.md  # LLM Deployment Guide
│   ├── monitoring.md      # Monitoring Stack Setup
│   ├── security.md        # Security & Network Isolation
│   └── troubleshooting.md # Troubleshooting Guide
├── src/
│   ├── components/        # React components
│   ├── css/              # Custom styles
│   └── pages/            # Custom pages (homepage)
├── static/               # Static assets
├── docusaurus.config.ts  # Site configuration
├── sidebars.ts          # Sidebar configuration
└── package.json         # Dependencies

🎨 Customization

Theme Colors

The site uses a custom AI/tech-focused color scheme defined in src/css/custom.css:

Configuration

Key configuration in docusaurus.config.ts:

📝 Content Management

Adding Documentation

  1. Create a new .md file in the docs/ directory
  2. Add frontmatter with sidebar_position to control ordering: 
    ---
sidebar_position: 6
---
  3. The sidebar will automatically update based on the file structure

Adding Blog Posts

  1. Create a new .md file in the blog/ directory
  2. Use the naming convention: YYYY-MM-DD-title.md
  3. Add frontmatter with metadata: 
    ---
slug: my-blog-post
title: My Blog Post Title
authors: [mohamed]
tags: [llm, docker, monitoring]
---

Supported Features

🚀 Deployment

GitHub Pages (Automatic)

The site automatically deploys to GitHub Pages when changes are pushed to the main branch, thanks to the GitHub Actions workflow in .github/workflows/deploy-docs.yml.

Deployment URL: https://1devspace.github.io/isolated-local-llm-deployment-monitoring-stack/

Manual Deployment

To deploy manually to GitHub Pages:

GIT_USER=<GITHUB_USERNAME> npm run deploy

This command builds the website and pushes to the gh-pages branch.

Other Hosting Platforms

The built site in the build/ directory can be deployed to any static hosting service:

🔧 Development Commands

# Install dependencies
npm install

# Start development server
npm start

# Build for production
npm run build

# Serve production build locally
npm run serve

# Clear cache (if needed)
npm run clear

# Type check (TypeScript)
npm run typecheck

# Deploy to GitHub Pages
npm run deploy

🎯 SEO and Performance

The site is optimized for:

🛠️ Troubleshooting

Common Issues

Build fails with dependency errors:

rm -rf node_modules package-lock.json
npm install

Local development server won’t start:

npm run clear
npm start

GitHub Pages deployment fails:

Getting Help

📊 Analytics and Monitoring

To add analytics to the site, configure in docusaurus.config.ts:

// Google Analytics
gtag: {
  trackingID: 'GA_TRACKING_ID',
},

// Google Tag Manager  
googleTagManager: {
  containerId: 'GTM_CONTAINER_ID',
},

🤝 Contributing

  1. Fork the repository
  2. Create a feature branch: git checkout -b feature/improve-docs
  3. Make your changes in the docs/ directory
  4. Test locally: npm start
  5. Commit your changes: git commit -am 'Improve documentation'
  6. Push to the branch: git push origin feature/improve-docs
  7. Create a Pull Request

Content Guidelines

Built with ❤️ using Docusaurus

This site is open source. Improve this page.