Linked Projects
This page links to documentation from other repositories and projects in our organization. This enables centralized access to all AI-related documentation across projects.
How Project Linking Works
Documentation from other repositories can be:
- Linked directly - Deep links to other repo docs
- Imported - Copied into this documentation site
- Auto-synchronized - Kept up-to-date via automation
Linked Projects
Project Template
For each linked project, we provide:
- Project overview
- Link to main documentation
- Key AI-related features
- Integration guides
- Last updated timestamp
Example Project 1
Repository: username/example-project
Description: Brief description of what this project does and how it uses AI.
AI Features:
- Feature 1: Description
- Feature 2: Description
Documentation Links:
Quick Start:
# Install
npm install example-project
# Use with AI
import { aiFeature } from 'example-project';Last Updated: 2024-11-18
Example Project 2
Repository: username/another-project
Description: Another project description.
AI Features:
- AI-powered feature description
Documentation Links:
Last Updated: 2024-11-18
Adding Your Project
To add your project to this documentation hub:
1. Manual Addition
Create a pull request adding your project to this page following the template above.
2. Automated Integration (Recommended)
Add this GitHub Action to your repository to automatically update this documentation when your project changes:
# .github/workflows/update-ai-hub-docs.yml
name: Update AI Hub Documentation
on:
push:
branches: [main]
paths:
- 'docs/**'
- 'README.md'
jobs:
update-docs:
runs-on: ubuntu-latest
steps:
- name: Checkout AI-Hub
uses: actions/checkout@v3
with:
repository: chriskellet/AI-Hub
token: ${{ secrets.AI_HUB_TOKEN }}
path: ai-hub
- name: Checkout current repo
uses: actions/checkout@v3
with:
path: current-repo
- name: Update documentation
run: |
# Copy/update relevant documentation
cp current-repo/docs/ai-*.md ai-hub/docs/external/projects/
# Update project listing
node ai-hub/scripts/update-project-listing.js
- name: Create Pull Request
uses: peter-evans/create-pull-request@v4
with:
path: ai-hub
token: ${{ secrets.AI_HUB_TOKEN }}
commit-message: "docs: Update ${{ github.repository }} documentation"
title: "docs: Update ${{ github.repository }} documentation"
body: |
Automated documentation update from ${{ github.repository }}
Triggered by: ${{ github.sha }}
Changes: ${{ github.event.head_commit.message }}3. Documentation Requirements
For your project to be listed:
- [ ] README.md with clear project description
- [ ] AI-related features documented
- [ ] Integration examples provided
- [ ] API documentation (if applicable)
- [ ] Contact information for maintainers
Documentation Synchronization
Automatic Updates
Projects configured with the GitHub Action above will automatically:
- Trigger on documentation changes
- Copy relevant docs to AI-Hub
- Create a PR for review
- Update the project listing
Manual Updates
If you prefer manual updates:
- Fork this repository
- Add/update your project documentation
- Submit a pull request
- Tag @maintainer for review
Bot-Driven Documentation Updates
As requested, documentation can be kept automatically synchronized:
Architecture
Your Project Repo
↓
[Code Change] → [CI/CD Pipeline]
↓
[Extract AI Docs] → [Generate Docs]
↓
[Create PR to AI-Hub] → [Auto/Manual Merge]
↓
[AI-Hub Deploys] → [Updated Docs Live]Implementation Example
// scripts/sync-docs-to-ai-hub.ts
interface DocSyncConfig {
sourceRepo: string;
sourcePaths: string[];
targetRepo: string;
targetPath: string;
autoMerge: boolean;
}
async function syncDocsToAIHub(config: DocSyncConfig) {
// 1. Clone both repositories
const sourceRepo = await cloneRepo(config.sourceRepo);
const targetRepo = await cloneRepo(config.targetRepo);
// 2. Extract and transform documentation
const docs = await extractDocs(sourceRepo, config.sourcePaths);
const transformed = await transformDocs(docs, {
addFrontmatter: true,
updateLinks: true,
addMetadata: {
sourceRepo: config.sourceRepo,
lastSync: new Date().toISOString(),
},
});
// 3. Copy to AI-Hub
await copyDocs(transformed, targetRepo, config.targetPath);
// 4. Create PR or commit directly
if (config.autoMerge) {
await commitAndPush(targetRepo, 'docs: Auto-sync from ' + config.sourceRepo);
} else {
await createPR(targetRepo, {
title: `docs: Update from ${config.sourceRepo}`,
body: generatePRBody(docs),
labels: ['documentation', 'auto-sync'],
});
}
}Setting Up Auto-Sync Bot
- Create GitHub App or use GitHub Actions (recommended)
- Configure repository webhook to trigger on doc changes
- Set up sync configuration per repository
- Enable auto-merge or require review based on sensitivity
Example configuration file:
# .ai-hub-sync.yml
sync:
enabled: true
paths:
- docs/ai-integration.md
- docs/api/ai-*.md
- README.md
target:
repo: chriskellet/AI-Hub
path: docs/external/projects/${{ repo.name }}/
options:
autoMerge: false # Require review
updateFrequency: on-push
notifyOn: [success, failure]Project Categories
Organize projects by category:
AI Integration Libraries
Projects providing AI integration capabilities:
- No projects listed yet - add yours!
AI-Powered Tools
Tools that use AI for enhanced functionality:
- No projects listed yet - add yours!
AI Best Practices Examples
Reference implementations and examples:
- No projects listed yet - add yours!
Shared AI Components
Reusable AI components across projects:
- No projects listed yet - add yours!
Documentation Standards
For consistency, linked projects should follow these standards:
Markdown Structure
# Project Name
## Overview
Brief description
## AI Features
List of AI-related features
## Quick Start
Getting started guide
## API Reference
If applicable
## Integration Guide
How to integrate with other systems
## Examples
Code examples
## Contributing
How to contribute
## License
License informationMetadata
Include frontmatter in documentation:
---
title: Project Name
category: integration-library
tags: [ai, llm, integration]
lastUpdated: 2024-11-18
sourceRepo: https://github.com/username/project
maintainers: [maintainer1, maintainer2]
---Search and Discovery
All linked documentation is:
- Searchable via the site search
- Categorized by project type
- Tagged for easy discovery
- Indexed by LLMs for AI accessibility
Maintenance
Regular Reviews
- Weekly: Check for broken links
- Monthly: Review and update project listings
- Quarterly: Audit documentation completeness
Health Checks
Automated checks monitor:
- Link validity
- Last update timestamps
- Build status of linked projects
- Documentation coverage
Contact
For questions about linking your project:
- Open an issue in this repository
- Contact the documentation team
- See Contributing Guidelines
Note: This documentation hub is designed to be easily accessible by both humans and LLMs. All linked documentation maintains this standard for optimal AI integration.