Enterprise AI documentation hub built with VitePress, featuring comprehensive guidelines, best practices, and tools for using AI in software development.
- 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
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
- Node.js 18 or higher
- npm or yarn
# Install dependencies
npm install
# Start development server
npm run docs:dev
# Access at http://localhost:5173# Build static site
npm run docs:build
# Preview production build
npm run docs:previewThis site is automatically deployed to GitHub Pages when changes are pushed to the main branch.
Live Site: https://chriskellet.github.io/AI-Hub/
# Build the site
npm run docs:build
# The built files will be in docs/.vitepress/distAdd 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- Fork this repository
- Add your project to
docs/external/projects.md - Submit a pull request
See Linked Projects Documentation for details.
- Start with Getting Started
- Review Security Guidelines
- Explore Best Practices
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
Contributions are welcome! Please:
- Read the documentation standards in
docs/external/projects.md - Follow the existing structure and style
- Test your changes locally
- Submit a pull request
# Create new documentation
docs/
category/
new-topic.md
# Update navigation in
docs/.vitepress/config.mtsMIT License - see LICENSE file for details
Documentation can be automatically synchronized from other repositories:
- Configure
.ai-hub-sync.ymlin your repository - Install the sync bot or use GitHub Actions
- Documentation updates trigger automatic PRs
See Bot-Driven Updates for implementation details.
- Open an issue for questions or suggestions
- See Contributing Guidelines
- Contact: Repository Owner
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.