mirror of
https://github.com/Significant-Gravitas/AutoGPT.git
synced 2026-01-09 07:08:09 -05:00
## Summary Sync GitBook documentation changes from the gitbook branch to dev. This PR contains comprehensive documentation updates including new assets, content restructuring, and infrastructure improvements. ## Changes 🏗️ ### Documentation Updates - **New GitBook Assets**: Added 9 new documentation images and screenshots - Platform overview images (AGPT_Platform.png, Banner_image.png) - Feature illustrations (Contribute.png, Integrations.png, hosted.jpg, no-code.jpg, api-reference.jpg) - Screenshots and examples for better user guidance - **Content Updates**: Enhanced README.md and SUMMARY.md with improved structure and navigation - **Visual Documentation**: Added comprehensive visual guides for platform features ### Infrastructure - **Cloudflare Worker**: Added redirect handler for docs.agpt.co → agpt.co/docs migration - Complete URL mapping for 71+ redirect patterns - Handles platform blocks restructuring and edge cases - Ready for deployment to Cloudflare Workers ### Merge Conflict Resolution - **Clean merge from dev**: Successfully merged dev's major backend restructuring (server/ → api/) - **File resurrection fix**: Removed files that were accidentally resurrected during merge conflict resolution - Cleaned up BuilderActionButton.tsx (deleted in dev) - Cleaned up old PreviewBanner.tsx location (moved in dev) - Synced pnpm-lock.yaml and layout.tsx with dev's current state ## Technical Details This PR represents a careful synchronization that: 1. **Preserves all GitBook documentation work** while staying current with dev 2. **Maintains clean diff**: Only documentation-related changes remain after merge cleanup 3. **Resolves merge conflicts**: Handled major backend API restructuring without breaking docs 4. **Infrastructure ready**: Cloudflare Worker ready for docs migration deployment ## Files Changed - `docs/`: GitBook documentation assets and content - `autogpt_platform/cloudflare_worker.js`: Docs infrastructure for URL redirects ## Validation - ✅ All TypeScript compilation errors resolved - ✅ Pre-commit hooks passing (Prettier, TypeCheck) - ✅ Only documentation changes remain in diff vs dev - ✅ Cloudflare Worker tested with comprehensive URL mapping - ✅ No non-documentation code changes after cleanup ## Deployment Notes The Cloudflare Worker can be deployed via: ```bash # Cloudflare Dashboard → Workers → Create → Paste code → Add route docs.agpt.co/* ``` This completes the GitBook synchronization and prepares for docs site migration. --------- Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: bobby.gaffin <bobby.gaffin@agpt.co> Co-authored-by: Bently <Github@bentlybro.com> Co-authored-by: Abhimanyu Yadav <122007096+Abhi1992002@users.noreply.github.com> Co-authored-by: Swifty <craigswift13@gmail.com> Co-authored-by: Ubbe <hi@ubbe.dev> Co-authored-by: Reinier van der Leer <pwuts@agpt.co> Co-authored-by: Claude <noreply@anthropic.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Lluis Agusti <hi@llu.lu>
146 lines
5.7 KiB
JavaScript
146 lines
5.7 KiB
JavaScript
/**
|
|
* Cloudflare Workers Script for docs.agpt.co → agpt.co/docs migration
|
|
*
|
|
* Deploy this script to handle all redirects with a single JavaScript file.
|
|
* No rule limits, easy to maintain, handles all edge cases.
|
|
*/
|
|
|
|
// URL mapping for special cases that don't follow patterns
|
|
const SPECIAL_MAPPINGS = {
|
|
// Root page
|
|
'/': '/docs/platform',
|
|
|
|
// Special cases that don't follow standard patterns
|
|
'/platform/d_id/': '/docs/integrations/block-integrations/d-id',
|
|
'/platform/blocks/blocks/': '/docs/integrations',
|
|
'/platform/blocks/decoder_block/': '/docs/integrations/block-integrations/text-decoder',
|
|
'/platform/blocks/http': '/docs/integrations/block-integrations/send-web-request',
|
|
'/platform/blocks/llm/': '/docs/integrations/block-integrations/ai-and-llm',
|
|
'/platform/blocks/time_blocks': '/docs/integrations/block-integrations/time-and-date',
|
|
'/platform/blocks/text_to_speech_block': '/docs/integrations/block-integrations/text-to-speech',
|
|
'/platform/blocks/ai_shortform_video_block': '/docs/integrations/block-integrations/ai-shortform-video',
|
|
'/platform/blocks/replicate_flux_advanced': '/docs/integrations/block-integrations/replicate-flux-advanced',
|
|
'/platform/blocks/flux_kontext': '/docs/integrations/block-integrations/flux-kontext',
|
|
'/platform/blocks/ai_condition/': '/docs/integrations/block-integrations/ai-condition',
|
|
'/platform/blocks/email_block': '/docs/integrations/block-integrations/email',
|
|
'/platform/blocks/google_maps': '/docs/integrations/block-integrations/google-maps',
|
|
'/platform/blocks/google/gmail': '/docs/integrations/block-integrations/gmail',
|
|
'/platform/blocks/github/issues/': '/docs/integrations/block-integrations/github-issues',
|
|
'/platform/blocks/github/repo/': '/docs/integrations/block-integrations/github-repo',
|
|
'/platform/blocks/github/pull_requests': '/docs/integrations/block-integrations/github-pull-requests',
|
|
'/platform/blocks/twitter/twitter': '/docs/integrations/block-integrations/twitter',
|
|
'/classic/setup/': '/docs/classic/setup/setting-up-autogpt-classic',
|
|
'/code-of-conduct/': '/docs/classic/help-us-improve-autogpt/code-of-conduct',
|
|
'/contributing/': '/docs/classic/contributing',
|
|
'/contribute/': '/docs/contribute',
|
|
'/forge/components/introduction/': '/docs/classic/forge/introduction'
|
|
};
|
|
|
|
/**
|
|
* Transform path by replacing underscores with hyphens and removing trailing slashes
|
|
*/
|
|
function transformPath(path) {
|
|
return path.replace(/_/g, '-').replace(/\/$/, '');
|
|
}
|
|
|
|
/**
|
|
* Handle docs.agpt.co redirects
|
|
*/
|
|
function handleDocsRedirect(url) {
|
|
const pathname = url.pathname;
|
|
|
|
// Check special mappings first
|
|
if (SPECIAL_MAPPINGS[pathname]) {
|
|
return `https://agpt.co${SPECIAL_MAPPINGS[pathname]}`;
|
|
}
|
|
|
|
// Pattern-based redirects
|
|
|
|
// Platform blocks: /platform/blocks/* → /docs/integrations/block-integrations/*
|
|
if (pathname.startsWith('/platform/blocks/')) {
|
|
const blockName = pathname.substring('/platform/blocks/'.length);
|
|
const transformedName = transformPath(blockName);
|
|
return `https://agpt.co/docs/integrations/block-integrations/${transformedName}`;
|
|
}
|
|
|
|
// Platform contributing: /platform/contributing/* → /docs/platform/contributing/*
|
|
if (pathname.startsWith('/platform/contributing/')) {
|
|
const subPath = pathname.substring('/platform/contributing/'.length);
|
|
return `https://agpt.co/docs/platform/contributing/${subPath}`;
|
|
}
|
|
|
|
// Platform general: /platform/* → /docs/platform/* (with underscore→hyphen)
|
|
if (pathname.startsWith('/platform/')) {
|
|
const subPath = pathname.substring('/platform/'.length);
|
|
const transformedPath = transformPath(subPath);
|
|
return `https://agpt.co/docs/platform/${transformedPath}`;
|
|
}
|
|
|
|
// Forge components: /forge/components/* → /docs/classic/forge/introduction/*
|
|
if (pathname.startsWith('/forge/components/')) {
|
|
const subPath = pathname.substring('/forge/components/'.length);
|
|
return `https://agpt.co/docs/classic/forge/introduction/${subPath}`;
|
|
}
|
|
|
|
// Forge general: /forge/* → /docs/classic/forge/*
|
|
if (pathname.startsWith('/forge/')) {
|
|
const subPath = pathname.substring('/forge/'.length);
|
|
return `https://agpt.co/docs/classic/forge/${subPath}`;
|
|
}
|
|
|
|
// Classic: /classic/* → /docs/classic/*
|
|
if (pathname.startsWith('/classic/')) {
|
|
const subPath = pathname.substring('/classic/'.length);
|
|
return `https://agpt.co/docs/classic/${subPath}`;
|
|
}
|
|
|
|
// Default fallback
|
|
return 'https://agpt.co/docs/';
|
|
}
|
|
|
|
/**
|
|
* Main Worker function
|
|
*/
|
|
export default {
|
|
async fetch(request, env, ctx) {
|
|
const url = new URL(request.url);
|
|
|
|
// Only handle docs.agpt.co requests
|
|
if (url.hostname === 'docs.agpt.co') {
|
|
const redirectUrl = handleDocsRedirect(url);
|
|
|
|
return new Response(null, {
|
|
status: 301,
|
|
headers: {
|
|
'Location': redirectUrl,
|
|
'Cache-Control': 'max-age=300' // Cache redirects for 5 minutes
|
|
}
|
|
});
|
|
}
|
|
|
|
// For non-docs requests, pass through or return 404
|
|
return new Response('Not Found', { status: 404 });
|
|
}
|
|
};
|
|
|
|
// Test function for local development
|
|
export function testRedirects() {
|
|
const testCases = [
|
|
'https://docs.agpt.co/',
|
|
'https://docs.agpt.co/platform/getting-started/',
|
|
'https://docs.agpt.co/platform/advanced_setup/',
|
|
'https://docs.agpt.co/platform/blocks/basic/',
|
|
'https://docs.agpt.co/platform/blocks/ai_condition/',
|
|
'https://docs.agpt.co/classic/setup/',
|
|
'https://docs.agpt.co/forge/components/agents/',
|
|
'https://docs.agpt.co/contributing/',
|
|
'https://docs.agpt.co/unknown-page'
|
|
];
|
|
|
|
console.log('Testing redirects:');
|
|
testCases.forEach(testUrl => {
|
|
const url = new URL(testUrl);
|
|
const result = handleDocsRedirect(url);
|
|
console.log(`${testUrl} → ${result}`);
|
|
});
|
|
} |