Skip to content
chriskelletPublic

About

No description, website, or topics provided.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Latest commit

 

History

1 Commit

Folders and files

Repository files navigation

AI Hub Documentation

Enterprise AI documentation hub built with VitePress, featuring comprehensive guidelines, best practices, and tools for using AI in software development.

🚀 Features

  • Comprehensive Guidelines - Security, privacy, ethical use, and prompt engineering
  • Tool Documentation - Claude, LLM APIs, and integration patterns
  • Best Practices - Code review, documentation, and testing with AI
  • Powerful Search - Built-in local search functionality
  • LLM-Accessible - Optimized structure for AI assistants to read and reference
  • Cross-Project Links - Link documentation from multiple repositories
  • Auto-Sync - Support for automated documentation updates from other projects

📚 Documentation Structure

docs/
├── index.md                    # Home page
├── getting-started.md          # Getting started guide
├── guidelines/                 # AI usage guidelines
│   ├── prompt-engineering.md   # Prompt engineering best practices
│   ├── security-privacy.md     # Security and privacy guidelines
│   └── ethical-use.md          # Ethical AI usage
├── tools/                      # Tool documentation
│   ├── claude.md              # Claude AI assistant
│   ├── llm-apis.md            # LLM API integration
│   └── integration-patterns.md # Common integration patterns
├── best-practices/            # Best practices
│   ├── code-review.md         # AI-assisted code review
│   ├── documentation.md       # Documentation with AI
│   └── testing.md             # Testing AI features
└── external/                  # Linked projects
    └── projects.md            # External project documentation

🛠️ Development

Prerequisites

  • Node.js 18 or higher
  • npm or yarn

Local Development

# Install dependencies
npm install

# Start development server
npm run docs:dev

# Access at http://localhost:5173

Build

# Build static site
npm run docs:build

# Preview production build
npm run docs:preview

🌐 Deployment

This site is automatically deployed to GitHub Pages when changes are pushed to the main branch.

Live Site: https://chriskellet.github.io/AI-Hub/

Manual Deployment

# Build the site
npm run docs:build

# The built files will be in docs/.vitepress/dist

🔗 Linking External Projects

Automated Sync

Add this GitHub Action to your project repository:

# .github/workflows/sync-to-ai-hub.yml
name: Sync to AI Hub

on:
  push:
    branches: [main]
    paths: ['docs/**']

jobs:
  sync:
    runs-on: ubuntu-latest
    steps:
      - name: Trigger AI Hub Update
        run: |
          # Sync your documentation to AI Hub
          # See docs/external/projects.md for full setup

Manual Addition

  1. Fork this repository
  2. Add your project to docs/external/projects.md
  3. Submit a pull request

See Linked Projects Documentation for details.

📖 Using This Documentation

For Developers

For LLMs/AI Assistants

This documentation is structured for easy parsing:

  • Clean markdown format
  • Semantic headings
  • Comprehensive metadata
  • Example-rich content
  • Consistent structure

LLMs can reference this documentation to:

  • Provide accurate AI usage guidance
  • Answer questions about best practices
  • Generate compliant code examples
  • Guide users on security and privacy

🤝 Contributing

Contributions are welcome! Please:

  1. Read the documentation standards in docs/external/projects.md
  2. Follow the existing structure and style
  3. Test your changes locally
  4. Submit a pull request

Adding Content

# Create new documentation
docs/
  category/
    new-topic.md

# Update navigation in
docs/.vitepress/config.mts

📝 License

MIT License - see LICENSE file for details

🔄 Auto-Update Bot

Documentation can be automatically synchronized from other repositories:

Setup

  1. Configure .ai-hub-sync.yml in your repository
  2. Install the sync bot or use GitHub Actions
  3. Documentation updates trigger automatic PRs

See Bot-Driven Updates for implementation details.

📧 Contact

🎯 Goals

This documentation hub aims to:

  • Centralize AI knowledge across the organization
  • Standardize AI usage practices
  • Enable safe and effective AI adoption
  • Connect documentation from multiple projects
  • Provide LLM-accessible reference material
  • Automate documentation maintenance

Built with VitePress - The Vue-powered static site generator optimized for technical documentation.

About

No description, website, or topics provided.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors