From a065ed35b2c279e57e1b0f2d72555da9bb039fb2 Mon Sep 17 00:00:00 2001 From: Saurav Panda Date: Tue, 3 Dec 2024 00:46:13 -0800 Subject: [PATCH] Readme docs url fixed and new updates released --- docs/compiled/de/docs/_meta.json | 86 +-- docs/compiled/en/docs/_meta.json | 90 +-- docs/compiled/es/docs/_meta.json | 18 +- docs/compiled/fr/docs/_meta.json | 52 +- docs/public/context/en_docs.txt | 858 +++++++++++++------------- docs/public/sitemap.xml | 296 +++++++++ packages/akiradocs/README.md | 10 +- packages/akiradocs/scripts/compile.js | 6 +- packages/create-app/package.json | 2 +- 9 files changed, 858 insertions(+), 560 deletions(-) diff --git a/docs/compiled/de/docs/_meta.json b/docs/compiled/de/docs/_meta.json index cec5de2..affcd59 100644 --- a/docs/compiled/de/docs/_meta.json +++ b/docs/compiled/de/docs/_meta.json @@ -17,6 +17,23 @@ } } }, + "internationalization": { + "title": "Internationalization", + "items": { + "setup": { + "title": "Einrichten der Internationalisierung", + "path": "/docs/internationalization/setup" + }, + "managingTranslation": { + "title": "Übersetzungen verwalten", + "path": "/docs/internationalization/managing-translation" + }, + "aiTranslation": { + "title": "KI-gestützte Übersetzung", + "path": "/docs/internationalization/ai-translation" + } + } + }, "installation": { "title": "Installation", "items": { @@ -34,6 +51,15 @@ } } }, + "guides": { + "title": "Guides", + "items": { + "analytics": { + "title": "Analyseintegration", + "path": "/docs/guides/analytics" + } + } + }, "gettingStarted": { "title": "Getting-started", "items": { @@ -51,28 +77,6 @@ } } }, - "editor": { - "title": "Editor", - "items": { - "overview": { - "title": "Überblick über den Editor", - "path": "/docs/editor/overview" - }, - "features": { - "title": "Editormerkmale", - "path": "/docs/editor/features" - } - } - }, - "guides": { - "title": "Guides", - "items": { - "analytics": { - "title": "Analyseintegration", - "path": "/docs/guides/analytics" - } - } - }, "contributing": { "title": "Contributing", "items": { @@ -86,29 +90,16 @@ } } }, - "internationalization": { - "title": "Internationalization", + "editor": { + "title": "Editor", "items": { - "setup": { - "title": "Einrichten der Internationalisierung", - "path": "/docs/internationalization/setup" - }, - "managingTranslation": { - "title": "Übersetzungen verwalten", - "path": "/docs/internationalization/managing-translation" + "overview": { + "title": "Überblick über den Editor", + "path": "/docs/editor/overview" }, - "aiTranslation": { - "title": "KI-gestützte Übersetzung", - "path": "/docs/internationalization/ai-translation" - } - } - }, - "apiReference": { - "title": "Api-reference", - "items": { - "usageGuide": { - "title": "API-Dokumentationsleitfaden", - "path": "/docs/api-reference/usage-guide" + "features": { + "title": "Editormerkmale", + "path": "/docs/editor/features" } } }, @@ -120,5 +111,14 @@ "path": "/docs/content-management/creating-pages" } } + }, + "apiReference": { + "title": "Api-reference", + "items": { + "usageGuide": { + "title": "API-Dokumentationsleitfaden", + "path": "/docs/api-reference/usage-guide" + } + } } } \ No newline at end of file diff --git a/docs/compiled/en/docs/_meta.json b/docs/compiled/en/docs/_meta.json index c051711..e604b8a 100644 --- a/docs/compiled/en/docs/_meta.json +++ b/docs/compiled/en/docs/_meta.json @@ -17,20 +17,20 @@ } } }, - "internationalization": { - "title": "Internationalization", + "installation": { + "title": "Installation", "items": { + "troubleshooting": { + "title": "Troubleshooting", + "path": "/docs/installation/troubleshooting" + }, "setup": { "title": "Setup", - "path": "/docs/internationalization/setup" - }, - "managingTranslation": { - "title": "Managing-translation", - "path": "/docs/internationalization/managing-translation" + "path": "/docs/installation/setup" }, - "aiTranslation": { - "title": "Ai-translation", - "path": "/docs/internationalization/ai-translation" + "configuration": { + "title": "Configuration", + "path": "/docs/installation/configuration" } } }, @@ -43,33 +43,33 @@ } } }, - "installation": { - "title": "Installation", + "internationalization": { + "title": "Internationalization", "items": { - "troubleshooting": { - "title": "Troubleshooting", - "path": "/docs/installation/troubleshooting" - }, "setup": { "title": "Setup", - "path": "/docs/installation/setup" + "path": "/docs/internationalization/setup" }, - "configuration": { - "title": "Configuration", - "path": "/docs/installation/configuration" + "managingTranslation": { + "title": "Managing-translation", + "path": "/docs/internationalization/managing-translation" + }, + "aiTranslation": { + "title": "Ai-translation", + "path": "/docs/internationalization/ai-translation" } } }, - "editor": { - "title": "Editor", + "contributing": { + "title": "Contributing", "items": { - "overview": { - "title": "Overview", - "path": "/docs/editor/overview" + "howToContribute": { + "title": "How-to-contribute", + "path": "/docs/contributing/how-to-contribute" }, - "features": { - "title": "Features", - "path": "/docs/editor/features" + "codeOfConduct": { + "title": "Code-of-conduct", + "path": "/docs/contributing/code-of-conduct" } } }, @@ -82,16 +82,25 @@ } } }, - "contributing": { - "title": "Contributing", + "editor": { + "title": "Editor", "items": { - "howToContribute": { - "title": "How-to-contribute", - "path": "/docs/contributing/how-to-contribute" + "overview": { + "title": "Overview", + "path": "/docs/editor/overview" }, - "codeOfConduct": { - "title": "Code-of-conduct", - "path": "/docs/contributing/code-of-conduct" + "features": { + "title": "Features", + "path": "/docs/editor/features" + } + } + }, + "apiReference": { + "title": "Api-reference", + "items": { + "usageGuide": { + "title": "Usage-guide", + "path": "/docs/api-reference/usage-guide" } } }, @@ -111,14 +120,5 @@ "path": "/docs/getting-started/features" } } - }, - "apiReference": { - "title": "Api-reference", - "items": { - "usageGuide": { - "title": "Usage-guide", - "path": "/docs/api-reference/usage-guide" - } - } } } \ No newline at end of file diff --git a/docs/compiled/es/docs/_meta.json b/docs/compiled/es/docs/_meta.json index f8b9486..2d36f6e 100644 --- a/docs/compiled/es/docs/_meta.json +++ b/docs/compiled/es/docs/_meta.json @@ -90,15 +90,6 @@ } } }, - "contentManagement": { - "title": "Content-management", - "items": { - "creatingPages": { - "title": "Creación y organización de páginas", - "path": "/docs/content-management/creating-pages" - } - } - }, "contributing": { "title": "Contributing", "items": { @@ -112,6 +103,15 @@ } } }, + "contentManagement": { + "title": "Content-management", + "items": { + "creatingPages": { + "title": "Creación y organización de páginas", + "path": "/docs/content-management/creating-pages" + } + } + }, "apiReference": { "title": "Api-reference", "items": { diff --git a/docs/compiled/fr/docs/_meta.json b/docs/compiled/fr/docs/_meta.json index ffd7eff..a022f07 100644 --- a/docs/compiled/fr/docs/_meta.json +++ b/docs/compiled/fr/docs/_meta.json @@ -17,23 +17,6 @@ } } }, - "internationalization": { - "title": "Internationalization", - "items": { - "setup": { - "title": "Configurer l'internationalisation", - "path": "/docs/internationalization/setup" - }, - "managingTranslation": { - "title": "Voici la traduction en français :\n\nGestion des traductions", - "path": "/docs/internationalization/managing-translation" - }, - "aiTranslation": { - "title": "Voici la traduction en français, avec le formatage d'origine conservé :\n\nTraduction alimentée par l'IA", - "path": "/docs/internationalization/ai-translation" - } - } - }, "installation": { "title": "Installation", "items": { @@ -51,6 +34,23 @@ } } }, + "internationalization": { + "title": "Internationalization", + "items": { + "setup": { + "title": "Configurer l'internationalisation", + "path": "/docs/internationalization/setup" + }, + "managingTranslation": { + "title": "Voici la traduction en français :\n\nGestion des traductions", + "path": "/docs/internationalization/managing-translation" + }, + "aiTranslation": { + "title": "Voici la traduction en français, avec le formatage d'origine conservé :\n\nTraduction alimentée par l'IA", + "path": "/docs/internationalization/ai-translation" + } + } + }, "guides": { "title": "Guides", "items": { @@ -103,15 +103,6 @@ } } }, - "apiReference": { - "title": "Api-reference", - "items": { - "usageGuide": { - "title": "Voici la traduction en français :\n\nGuide de documentation de l'API", - "path": "/docs/api-reference/usage-guide" - } - } - }, "contentManagement": { "title": "Content-management", "items": { @@ -120,5 +111,14 @@ "path": "/docs/content-management/creating-pages" } } + }, + "apiReference": { + "title": "Api-reference", + "items": { + "usageGuide": { + "title": "Voici la traduction en français :\n\nGuide de documentation de l'API", + "path": "/docs/api-reference/usage-guide" + } + } } } \ No newline at end of file diff --git a/docs/public/context/en_docs.txt b/docs/public/context/en_docs.txt index 00c7188..3b2dbe2 100644 --- a/docs/public/context/en_docs.txt +++ b/docs/public/context/en_docs.txt @@ -90,6 +90,44 @@ ai_assistant: Next Steps Explore our [Advanced AI Features](/advanced-ai-features) guide to learn more about specialized use cases and integration possibilities. ------------- +[Document: docs/seo-and-performance/sitemap-generation.json] +Title: Automatic Sitemap Generation +Learn how AkiraDocs automatically generates and manages your documentation sitemap. +Overview +AkiraDocs automatically generates a sitemap.xml file during the build process, ensuring search engines can efficiently crawl your documentation. +Generated Sitemap Structure +Example Output +Code example: + + + + https://yourdocs.com/ + 2024-11-26 + weekly + 1.0 + + + https://yourdocs.com/docs/getting-started + 2024-11-26 + weekly + 0.8 + + +------------- +[Document: docs/seo-and-performance/robot-txt.json] +Title: Robots.txt Configuration +The robots.txt file is automatically generated during the build process and can be found in the `public` folder of your project. +Default Configuration +Basic robots.txt +Code example: +User-agent: * +Allow: / +Sitemap: https://docs.akiradocs.com/sitemap.xml + +# Private sections +Disallow: /admin/ +Disallow: /private/ +------------- [Document: docs/internationalization/setup.json] Title: Setting Up Internationalization Configure AkiraDocs for multiple languages with AI-powered translation support. @@ -213,44 +251,6 @@ Context-aware translations Technical term preservation Format maintenance ------------- -[Document: docs/seo-and-performance/sitemap-generation.json] -Title: Automatic Sitemap Generation -Learn how AkiraDocs automatically generates and manages your documentation sitemap. -Overview -AkiraDocs automatically generates a sitemap.xml file during the build process, ensuring search engines can efficiently crawl your documentation. -Generated Sitemap Structure -Example Output -Code example: - - - - https://yourdocs.com/ - 2024-11-26 - weekly - 1.0 - - - https://yourdocs.com/docs/getting-started - 2024-11-26 - weekly - 0.8 - - -------------- -[Document: docs/seo-and-performance/robot-txt.json] -Title: Robots.txt Configuration -The robots.txt file is automatically generated during the build process and can be found in the `public` folder of your project. -Default Configuration -Basic robots.txt -Code example: -User-agent: * -Allow: / -Sitemap: https://docs.akiradocs.com/sitemap.xml - -# Private sections -Disallow: /admin/ -Disallow: /private/ -------------- [Document: docs/guides/analytics.json] Title: Analytics Integration Learn how to add analytics tracking to your documentation @@ -300,61 +300,74 @@ Code example: } This provides a complete analytics integration that's easy for users to set up and extend as needed. ------------- -[Document: docs/installation/troubleshooting.json] -Title: Troubleshooting Guide -Common issues and their solutions when setting up AkiraDocs. -Common Installation Issues -Node.js Version Mismatch -Problem: Error about Node.js version compatibility -Code example: -Error: The engine "node" is incompatible with this module -Solution: -1. Check your Node.js version: -Code example: -node --version -2. Install the correct version (16.x or higher) -3. Use nvm to manage Node.js versions: +[Document: docs/getting-started/requirements.json] +Title: System Requirements +Before installing AkiraDocs, ensure your environment meets the following requirements. +Minimum Requirements +Node.js +Version: 16.x or higher +Recommended: Latest LTS version +System Memory +Minimum: 2GB RAM +Recommended: 4GB RAM or more +Storage +Recommended: 1GB free space +Software Dependencies +Required +Git (latest version recommended) +npm or yarn package manager +Modern web browser (Chrome, Firefox, Safari, Edge) +Optional +Docker (for containerized deployment) +PostgreSQL (for enterprise features) +Development Environment +Supported Operating Systems +macOS (10.15 or later) +Windows 10/11 +Linux (Ubuntu 20.04 or later recommended) +IDE/Editor Support +VS Code (coming soon) +WebStorm (coming soon) +Any text editor with Markdown support +------------- +[Document: docs/getting-started/quickstart.json] +Title: Quickstart Guide +Get up and running with AkiraDocs in minutes. +Quick Deploy +Option 1: Deploy with Vercel +The fastest way to get started is using Vercel: +[![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2FCloud-Code-AI%2Fakiradocs-template) +Option 2: Using CLI +Create a new project using our CLI: Code example: -nvm install 20 -nvm use 20 -Dependencies Installation Failed -Problem: npm install fails with errors -Solution: -1. Clear npm cache: +npx create-akiradocs@latest my-docs +Basic Setup Steps +1. Clone the Repository (if not using Quick Deploy) Code example: -npm cache clean --force -2. Delete node_modules and package-lock.json: +git clone https://github.com/your-org/akira-docs-template +cd akira-docs-template +2. Install Dependencies Code example: -rm -rf node_modules package-lock.json npm install -Build Issues -Build Fails -Problem: `npm run build` fails -Solution: -1. Check for TypeScript errors: -Code example: -npm run type-check -2. Verify environment variables are set correctly -3. Clear next.js cache: +# or +yarn install +3. Start Development Server Code example: -rm -rf .next -Static Export Issues -Problem: Static export fails with dynamic routes -Solution: -1. Configure `next.config.js`: +npm run dev +# or +yarn dev +4. Open `http://localhost:3000` in your browser +Initial Configuration +1. Update Site Configuration +Edit `akiradocs.config.json`: Code example: -module.exports = { - output: 'export', - images: { - unoptimized: true +{ + "site": { + "title": "Your Docs", + "description": "Your documentation description" } } -Translation Issues -AI Translation Not Working -Problem: Automatic translation fails -Solution: -1. Verify API keys are set correctly -2. Check translation configuration: +2. Configure Translation (Optional) Code example: { "translation": { @@ -363,267 +376,31 @@ Code example: "targetLanguages": ["es", "fr", "de"] } } -Content Issues -Content Not Updating -Problem: Changes to content files not reflecting -Solution: -Content changes are built on build time. If you are using the local development server, you need to restart the server after making changes. -1. Clear the cache: -Code example: -npm run clean -2. Restart the development server -3. Check file permissions -Deployment Issues -Vercel Deployment Failed -Problem: Deployment to Vercel fails -Solution: -1. Check build logs -2. Verify environment variables are set in Vercel dashboard -3. Ensure all dependencies are listed in package.json -Getting Help -If you're still experiencing issues: -1. Check our [GitHub Issues](https://github.com/Cloud-Code-AI/Akiradocs/issues) -2. Join our [Discord Community](https://discord.gg/zvYZukgeH2) -3. Contact [Support](mailto:saurav.panda@akiradocs.ai) ------------- -[Document: docs/installation/setup.json] -Title: Detailed Installation Guide -Complete guide to installing AkiraDocs in different environments. -Prerequisites -Ensure your system meets the [requirements](../getting-started/requirements.md) before proceeding. -Installation Methods -1. Local Development Setup -1. Create New Project -Code example: -npx create-akiradocs@latest my-docs-site -cd my-docs-site -2. Install Dependencies -Dependencies are automatically installed during project creation. If you need to reinstall: -Code example: -npm install -3. Create Environment File -The environment file is created automatically. You can modify it at `.env.local` -4. Start Development Server -Code example: -npm run dev -5. Update AkiraDocs -To update an existing installation to the latest version: -Code example: -npx create-akiradocs@latest update -3. Cloud Platform Deployment -Vercel -1. Fork the repository -2. Connect to Vercel -3. Configure environment variables -4. Deploy -Other Platforms -AWS Amplify (Coming Soon) -Netlify (Coming Soon) -Digital Ocean (Coming Soon) -Custom server (Coming Soon) -Post-Installation Steps -1. Verify Installation -Code example: -npm run build -npm run start -2. Configure Git Integration -Code example: -git remote add origin your-repository-url -3. Setup Content Directory -Code example: -mkdir -p docs/_contents/en -Environment-Specific Configurations -Development -Code example: -NODE_ENV=development -DEBUG=true -Production -Code example: -NODE_ENV=production -DEBUG=false -Testing -Code example: -NODE_ENV=test -TEST_MODE=true -------------- -[Document: docs/installation/configuration.json] -Title: Configuration Guide -Complete guide to configuring your AkiraDocs installation. -Core Configuration -Site Configuration -Edit `akiradocs.config.json`: -Code example: -{ - "url": "https://docs.akiradocs.com", - "site": { - "title": "Your Docs", - "description": "Your documentation description" - }, - "branding": { - "logo": { - "path": "/your_logo.svg", - "width": 120, - "height": 30, - "show": true - }, - "favicon": { - "path": "/favicon.png", - "show": true - } - } -} -Navigation Setup -Code example: -{ - "navigation": { - "header": { - "items": [ - { "label": "Docs", "href": "/docs", "icon": "/docs.svg" }, - { "label": "API", "href": "/api", "icon": "/api.svg" } - ] - } - } -} -Internationalization -Language Configuration -Code example: -{ - "localization": { - "defaultLocale": "en", - "fallbackLocale": "en", - "locales": [ - { - "code": "en", - "name": "English", - "flag": "🇺🇸" - }, - { - "code": "es", - "name": "Español", - "flag": "🇪🇸" - }, - { - "code": "fr", - "name": "Français", - "flag": "🇫🇷" - }, - { - "code": "de", - "name": "Deutsch", - "flag": "🇩🇪" - } - ] - }, - "translation": { - "auto_translate": true, - "provider": "anthropic", - "model": "claude-3-sonnet-20240229", - "targetLanguages": ["es", "fr", "de"], - "excludedPaths": ["_meta.json"] - }, -} -------------- -[Document: docs/getting-started/requirements.json] -Title: System Requirements -Before installing AkiraDocs, ensure your environment meets the following requirements. -Minimum Requirements -Node.js -Version: 16.x or higher -Recommended: Latest LTS version -System Memory -Minimum: 2GB RAM -Recommended: 4GB RAM or more -Storage -Recommended: 1GB free space -Software Dependencies -Required -Git (latest version recommended) -npm or yarn package manager -Modern web browser (Chrome, Firefox, Safari, Edge) -Optional -Docker (for containerized deployment) -PostgreSQL (for enterprise features) -Development Environment -Supported Operating Systems -macOS (10.15 or later) -Windows 10/11 -Linux (Ubuntu 20.04 or later recommended) -IDE/Editor Support -VS Code (coming soon) -WebStorm (coming soon) -Any text editor with Markdown support -------------- -[Document: docs/getting-started/quickstart.json] -Title: Quickstart Guide -Get up and running with AkiraDocs in minutes. -Quick Deploy -Option 1: Deploy with Vercel -The fastest way to get started is using Vercel: -[![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2FCloud-Code-AI%2Fakiradocs-template) -Option 2: Using CLI -Create a new project using our CLI: -Code example: -npx create-akiradocs@latest my-docs -Basic Setup Steps -1. Clone the Repository (if not using Quick Deploy) -Code example: -git clone https://github.com/your-org/akira-docs-template -cd akira-docs-template -2. Install Dependencies -Code example: -npm install -# or -yarn install -3. Start Development Server -Code example: -npm run dev -# or -yarn dev -4. Open `http://localhost:3000` in your browser -Initial Configuration -1. Update Site Configuration -Edit `akiradocs.config.json`: -Code example: -{ - "site": { - "title": "Your Docs", - "description": "Your documentation description" - } -} -2. Configure Translation (Optional) -Code example: -{ - "translation": { - "auto_translate": true, - "provider": "anthropic", - "targetLanguages": ["es", "fr", "de"] - } -} -------------- -[Document: docs/getting-started/features.json] -Title: AkiraDocs Features -A comprehensive overview of AkiraDocs' core features and capabilities. -Content Creation & Management -Notion-like Editor: Intuitive block-based interface with real-time preview -Markdown Support: Native Markdown and MDX compatibility -Custom Components: Create and reuse your own content blocks -Internationalization & Translation -Multi-Language Support: Maintain documentation in multiple languages -AI-Powered Translation: Automated, context-aware content translation -Translation Management: Built-in tools for managing localized content -Search & Discovery -AI-Powered Search: Natural language question answering with context awareness -SEO Optimization: Automated SEO tools and optimizations -Smart Indexing: Real-time search index updates -Build & Performance -Static Generation: Optimized build process with asset optimization -Developer Experience: Fast refresh and comprehensive debugging tools -Performance Focus: Built-in best practices for speed and efficiency -Enterprise Features (Coming Soon) -Security & Compliance: SSO, RBAC, and audit logging -Analytics & Insights: Usage tracking and documentation metrics -Team Collaboration: Enterprise-grade collaboration tools -Migration Support (Coming Soon) +[Document: docs/getting-started/features.json] +Title: AkiraDocs Features +A comprehensive overview of AkiraDocs' core features and capabilities. +Content Creation & Management +Notion-like Editor: Intuitive block-based interface with real-time preview +Markdown Support: Native Markdown and MDX compatibility +Custom Components: Create and reuse your own content blocks +Internationalization & Translation +Multi-Language Support: Maintain documentation in multiple languages +AI-Powered Translation: Automated, context-aware content translation +Translation Management: Built-in tools for managing localized content +Search & Discovery +AI-Powered Search: Natural language question answering with context awareness +SEO Optimization: Automated SEO tools and optimizations +Smart Indexing: Real-time search index updates +Build & Performance +Static Generation: Optimized build process with asset optimization +Developer Experience: Fast refresh and comprehensive debugging tools +Performance Focus: Built-in best practices for speed and efficiency +Enterprise Features (Coming Soon) +Security & Compliance: SSO, RBAC, and audit logging +Analytics & Insights: Usage tracking and documentation metrics +Team Collaboration: Enterprise-grade collaboration tools +Migration Support (Coming Soon) Code example: # Supported platforms for easy migration ✓ Nextra @@ -724,98 +501,228 @@ Git integration Change history Rollback capabilities ------------- -[Document: docs/contributing/how-to-contribute.json] -Title: Contributing to AkiraDocs -Guide to contributing to the AkiraDocs open-source project. -Getting Started -Setup Development Environment +[Document: docs/installation/troubleshooting.json] +Title: Troubleshooting Guide +Common issues and their solutions when setting up AkiraDocs. +Common Installation Issues +Node.js Version Mismatch +Problem: Error about Node.js version compatibility Code example: -# Clone repository -git clone https://github.com/Cloud-Code-AI/akiradocs -cd akiradocs - -# Install dependencies +Error: The engine "node" is incompatible with this module +Solution: +1. Check your Node.js version: +Code example: +node --version +2. Install the correct version (16.x or higher) +3. Use nvm to manage Node.js versions: +Code example: +nvm install 20 +nvm use 20 +Dependencies Installation Failed +Problem: npm install fails with errors +Solution: +1. Clear npm cache: +Code example: +npm cache clean --force +2. Delete node_modules and package-lock.json: +Code example: +rm -rf node_modules package-lock.json npm install - -# Start development server +Build Issues +Build Fails +Problem: `npm run build` fails +Solution: +1. Check for TypeScript errors: +Code example: +npm run type-check +2. Verify environment variables are set correctly +3. Clear next.js cache: +Code example: +rm -rf .next +Static Export Issues +Problem: Static export fails with dynamic routes +Solution: +1. Configure `next.config.js`: +Code example: +module.exports = { + output: 'export', + images: { + unoptimized: true + } +} +Translation Issues +AI Translation Not Working +Problem: Automatic translation fails +Solution: +1. Verify API keys are set correctly +2. Check translation configuration: +Code example: +{ + "translation": { + "auto_translate": true, + "provider": "anthropic", + "targetLanguages": ["es", "fr", "de"] + } +} +Content Issues +Content Not Updating +Problem: Changes to content files not reflecting +Solution: +Content changes are built on build time. If you are using the local development server, you need to restart the server after making changes. +1. Clear the cache: +Code example: +npm run clean +2. Restart the development server +3. Check file permissions +Deployment Issues +Vercel Deployment Failed +Problem: Deployment to Vercel fails +Solution: +1. Check build logs +2. Verify environment variables are set in Vercel dashboard +3. Ensure all dependencies are listed in package.json +Getting Help +If you're still experiencing issues: +1. Check our [GitHub Issues](https://github.com/Cloud-Code-AI/Akiradocs/issues) +2. Join our [Discord Community](https://discord.gg/zvYZukgeH2) +3. Contact [Support](mailto:saurav.panda@akiradocs.ai) +------------- +[Document: docs/installation/setup.json] +Title: Detailed Installation Guide +Complete guide to installing AkiraDocs in different environments. +Prerequisites +Ensure your system meets the [requirements](../getting-started/requirements.md) before proceeding. +Installation Methods +1. Local Development Setup +1. Create New Project +Code example: +npx create-akiradocs@latest my-docs-site +cd my-docs-site +2. Install Dependencies +Dependencies are automatically installed during project creation. If you need to reinstall: +Code example: +npm install +3. Create Environment File +The environment file is created automatically. You can modify it at `.env.local` +4. Start Development Server +Code example: npm run dev -Contribution Guidelines -Types of Contributions -Bug fixes -Feature additions -Documentation improvements -Translation help -Issue reporting -Pull Request Process +5. Update AkiraDocs +To update an existing installation to the latest version: +Code example: +npx create-akiradocs@latest update +3. Cloud Platform Deployment +Vercel 1. Fork the repository -2. Create feature branch -3. Make changes -4. Submit pull request -Commit Messages +2. Connect to Vercel +3. Configure environment variables +4. Deploy +Other Platforms +AWS Amplify (Coming Soon) +Netlify (Coming Soon) +Digital Ocean (Coming Soon) +Custom server (Coming Soon) +Post-Installation Steps +1. Verify Installation Code example: -# Format -type(scope): description - -# Examples -feat(editor): add new block type -fix(translation): correct language detection -docs(api): update authentication guide -Development Guidelines -Code Style -Follow existing patterns -Use TypeScript -Add comments -Write tests +npm run build +npm run start +2. Configure Git Integration +Code example: +git remote add origin your-repository-url +3. Setup Content Directory +Code example: +mkdir -p docs/_contents/en +Environment-Specific Configurations +Development +Code example: +NODE_ENV=development +DEBUG=true +Production +Code example: +NODE_ENV=production +DEBUG=false Testing Code example: -# Run tests -npm run test - -# Check types -npm run type-check - -# Lint code -npm run lint -Documentation -Update Docs -1. Edit relevant files -2. Update examples -3. Check links -4. Verify formatting -Create Examples -Clear and concise -Well-documented -Tested -Maintainable -Getting Help -Join [Discord](https://discord.gg/zvYZukgeH2) -Check [Issues](https://github.com/Cloud-Code-AI/akiradocs/issues) -Read [Documentation](https://docs.akiradocs.com) +NODE_ENV=test +TEST_MODE=true ------------- -[Document: docs/contributing/code-of-conduct.json] -Title: Code of Conduct -Our Pledge -We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation. -We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community. -Our Standards -Examples of behavior that contributes to a positive environment: -* Demonstrating empathy and kindness toward other people -* Being respectful of differing opinions, viewpoints, and experiences -* Giving and gracefully accepting constructive feedback -* Accepting responsibility and apologizing to those affected by our mistakes -* Focusing on what is best for the overall community -Examples of unacceptable behavior: -* The use of sexualized language or imagery, and sexual attention or advances -* Trolling, insulting or derogatory comments, and personal or political attacks -* Public or private harassment -* Publishing others' private information without explicit permission -* Other conduct which could reasonably be considered inappropriate in a professional setting -Enforcement Responsibilities -Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful. -Enforcement -Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement. All complaints will be reviewed and investigated promptly and fairly. -Attribution -This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org), version 2.0, available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html. +[Document: docs/installation/configuration.json] +Title: Configuration Guide +Complete guide to configuring your AkiraDocs installation. +Core Configuration +Site Configuration +Edit `akiradocs.config.json`: +Code example: +{ + "url": "https://docs.akiradocs.com", + "site": { + "title": "Your Docs", + "description": "Your documentation description" + }, + "branding": { + "logo": { + "path": "/your_logo.svg", + "width": 120, + "height": 30, + "show": true + }, + "favicon": { + "path": "/favicon.png", + "show": true + } + } +} +Navigation Setup +Code example: +{ + "navigation": { + "header": { + "items": [ + { "label": "Docs", "href": "/docs", "icon": "/docs.svg" }, + { "label": "API", "href": "/api", "icon": "/api.svg" } + ] + } + } +} +Internationalization +Language Configuration +Code example: +{ + "localization": { + "defaultLocale": "en", + "fallbackLocale": "en", + "locales": [ + { + "code": "en", + "name": "English", + "flag": "🇺🇸" + }, + { + "code": "es", + "name": "Español", + "flag": "🇪🇸" + }, + { + "code": "fr", + "name": "Français", + "flag": "🇫🇷" + }, + { + "code": "de", + "name": "Deutsch", + "flag": "🇩🇪" + } + ] + }, + "translation": { + "auto_translate": true, + "provider": "anthropic", + "model": "claude-3-sonnet-20240229", + "targetLanguages": ["es", "fr", "de"], + "excludedPaths": ["_meta.json"] + }, +} ------------- [Document: docs/content-management/creating-pages.json] Title: Creating and Organizing Pages @@ -947,4 +854,97 @@ Code example: } } } +------------- +[Document: docs/contributing/how-to-contribute.json] +Title: Contributing to AkiraDocs +Guide to contributing to the AkiraDocs open-source project. +Getting Started +Setup Development Environment +Code example: +# Clone repository +git clone https://github.com/Cloud-Code-AI/akiradocs +cd akiradocs + +# Install dependencies +npm install + +# Start development server +npm run dev +Contribution Guidelines +Types of Contributions +Bug fixes +Feature additions +Documentation improvements +Translation help +Issue reporting +Pull Request Process +1. Fork the repository +2. Create feature branch +3. Make changes +4. Submit pull request +Commit Messages +Code example: +# Format +type(scope): description + +# Examples +feat(editor): add new block type +fix(translation): correct language detection +docs(api): update authentication guide +Development Guidelines +Code Style +Follow existing patterns +Use TypeScript +Add comments +Write tests +Testing +Code example: +# Run tests +npm run test + +# Check types +npm run type-check + +# Lint code +npm run lint +Documentation +Update Docs +1. Edit relevant files +2. Update examples +3. Check links +4. Verify formatting +Create Examples +Clear and concise +Well-documented +Tested +Maintainable +Getting Help +Join [Discord](https://discord.gg/zvYZukgeH2) +Check [Issues](https://github.com/Cloud-Code-AI/akiradocs/issues) +Read [Documentation](https://docs.akiradocs.com) +------------- +[Document: docs/contributing/code-of-conduct.json] +Title: Code of Conduct +Our Pledge +We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation. +We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community. +Our Standards +Examples of behavior that contributes to a positive environment: +* Demonstrating empathy and kindness toward other people +* Being respectful of differing opinions, viewpoints, and experiences +* Giving and gracefully accepting constructive feedback +* Accepting responsibility and apologizing to those affected by our mistakes +* Focusing on what is best for the overall community +Examples of unacceptable behavior: +* The use of sexualized language or imagery, and sexual attention or advances +* Trolling, insulting or derogatory comments, and personal or political attacks +* Public or private harassment +* Publishing others' private information without explicit permission +* Other conduct which could reasonably be considered inappropriate in a professional setting +Enforcement Responsibilities +Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful. +Enforcement +Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement. All complaints will be reviewed and investigated promptly and fairly. +Attribution +This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org), version 2.0, available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html. ------------- \ No newline at end of file diff --git a/docs/public/sitemap.xml b/docs/public/sitemap.xml index 07becb5..49ab952 100644 --- a/docs/public/sitemap.xml +++ b/docs/public/sitemap.xml @@ -9,10 +9,78 @@ https://your-domain.com/fr/docs/_meta + + https://your-domain.com/fr/docs/seo-and-performance/sitemap-generation + + + + https://your-domain.com/fr/docs/seo-and-performance/robot-txt + + + + https://your-domain.com/fr/docs/internationalization/setup + + + + https://your-domain.com/fr/docs/internationalization/managing-translation + + + + https://your-domain.com/fr/docs/internationalization/ai-translation + + + + https://your-domain.com/fr/docs/installation/troubleshooting + + + + https://your-domain.com/fr/docs/installation/setup + + + + https://your-domain.com/fr/docs/installation/configuration + + + + https://your-domain.com/fr/docs/guides/analytics + + + + https://your-domain.com/fr/docs/getting-started/requirements + + https://your-domain.com/fr/docs/getting-started/quickstart + + https://your-domain.com/fr/docs/getting-started/features + + + + https://your-domain.com/fr/docs/editor/overview + + + + https://your-domain.com/fr/docs/editor/features + + + + https://your-domain.com/fr/docs/contributing/how-to-contribute + + + + https://your-domain.com/fr/docs/contributing/code-of-conduct + + + + https://your-domain.com/fr/docs/content-management/creating-pages + + + + https://your-domain.com/fr/docs/api-reference/usage-guide + + https://your-domain.com/fr/articles/welcome @@ -41,10 +109,78 @@ https://your-domain.com/es/docs/_meta + + https://your-domain.com/es/docs/seo-and-performance/sitemap-generation + + + + https://your-domain.com/es/docs/seo-and-performance/robot-txt + + + + https://your-domain.com/es/docs/internationalization/setup + + + + https://your-domain.com/es/docs/internationalization/managing-translation + + + + https://your-domain.com/es/docs/internationalization/ai-translation + + + + https://your-domain.com/es/docs/installation/troubleshooting + + + + https://your-domain.com/es/docs/installation/setup + + + + https://your-domain.com/es/docs/installation/configuration + + + + https://your-domain.com/es/docs/guides/analytics + + + + https://your-domain.com/es/docs/getting-started/requirements + + https://your-domain.com/es/docs/getting-started/quickstart + + https://your-domain.com/es/docs/getting-started/features + + + + https://your-domain.com/es/docs/editor/overview + + + + https://your-domain.com/es/docs/editor/features + + + + https://your-domain.com/es/docs/contributing/how-to-contribute + + + + https://your-domain.com/es/docs/contributing/code-of-conduct + + + + https://your-domain.com/es/docs/content-management/creating-pages + + + + https://your-domain.com/es/docs/api-reference/usage-guide + + https://your-domain.com/es/articles/welcome @@ -73,6 +209,50 @@ https://your-domain.com/en/docs/_meta + + https://your-domain.com/en/docs/seo-and-performance/sitemap-generation + + + + https://your-domain.com/en/docs/seo-and-performance/robot-txt + + + + https://your-domain.com/en/docs/seo-and-performance/_meta + + + + https://your-domain.com/en/docs/internationalization/setup + + + + https://your-domain.com/en/docs/internationalization/managing-translation + + + + https://your-domain.com/en/docs/internationalization/ai-translation + + + + https://your-domain.com/en/docs/internationalization/_meta + + + + https://your-domain.com/en/docs/installation/troubleshooting + + + + https://your-domain.com/en/docs/installation/setup + + + + https://your-domain.com/en/docs/installation/configuration + + + + https://your-domain.com/en/docs/installation/_meta + + https://your-domain.com/en/docs/guides/analytics @@ -81,14 +261,62 @@ https://your-domain.com/en/docs/guides/_meta + + https://your-domain.com/en/docs/getting-started/requirements + + https://your-domain.com/en/docs/getting-started/quickstart + + https://your-domain.com/en/docs/getting-started/features + + https://your-domain.com/en/docs/getting-started/_meta + + https://your-domain.com/en/docs/editor/overview + + + + https://your-domain.com/en/docs/editor/features + + + + https://your-domain.com/en/docs/editor/_meta + + + + https://your-domain.com/en/docs/contributing/how-to-contribute + + + + https://your-domain.com/en/docs/contributing/code-of-conduct + + + + https://your-domain.com/en/docs/contributing/_meta + + + + https://your-domain.com/en/docs/content-management/creating-pages + + + + https://your-domain.com/en/docs/content-management/_meta + + + + https://your-domain.com/en/docs/api-reference/usage-guide + + + + https://your-domain.com/en/docs/api-reference/_meta + + https://your-domain.com/en/articles/welcome @@ -117,10 +345,78 @@ https://your-domain.com/de/docs/_meta + + https://your-domain.com/de/docs/seo-and-performance/sitemap-generation + + + + https://your-domain.com/de/docs/seo-and-performance/robot-txt + + + + https://your-domain.com/de/docs/internationalization/setup + + + + https://your-domain.com/de/docs/internationalization/managing-translation + + + + https://your-domain.com/de/docs/internationalization/ai-translation + + + + https://your-domain.com/de/docs/installation/troubleshooting + + + + https://your-domain.com/de/docs/installation/setup + + + + https://your-domain.com/de/docs/installation/configuration + + + + https://your-domain.com/de/docs/guides/analytics + + + + https://your-domain.com/de/docs/getting-started/requirements + + https://your-domain.com/de/docs/getting-started/quickstart + + https://your-domain.com/de/docs/getting-started/features + + + + https://your-domain.com/de/docs/editor/overview + + + + https://your-domain.com/de/docs/editor/features + + + + https://your-domain.com/de/docs/contributing/how-to-contribute + + + + https://your-domain.com/de/docs/contributing/code-of-conduct + + + + https://your-domain.com/de/docs/content-management/creating-pages + + + + https://your-domain.com/de/docs/api-reference/usage-guide + + https://your-domain.com/de/articles/welcome diff --git a/packages/akiradocs/README.md b/packages/akiradocs/README.md index 692ecbb..7b66f97 100644 --- a/packages/akiradocs/README.md +++ b/packages/akiradocs/README.md @@ -162,14 +162,14 @@ npx create-akiradocs@latest mydocs - [Discord Community](https://discord.gg/akiradocs) - [GitHub Discussions](https://github.com/akiradocs/discussions) -- [Documentation](https://docs.akiradocs.com) -- [Enterprise Support (Coming Q1 2025)](https://akiradocs.com/enterprise) +- [Documentation](https://docs.akiradocs.ai) +- [Enterprise Support (Coming Q1 2025)](https://akiradocs.ai/enterprise) ---
-**[Get Started](https://docs.akiradocs.com/quickstart)** • -**[Live Demo](https://demo.akiradocs.com)** • -**[Enterprise Trial](https://akiradocs.com/enterprise)** (Coming Q1 2025) +**[Get Started](https://docs.akiradocs.ai/quickstart)** • +**[Live Demo](https://demo.akiradocs.ai)** • +**[Enterprise Trial](https://akiradocs.ai/enterprise)** (Coming Q1 2025)
\ No newline at end of file diff --git a/packages/akiradocs/scripts/compile.js b/packages/akiradocs/scripts/compile.js index acad923..0aaeed0 100644 --- a/packages/akiradocs/scripts/compile.js +++ b/packages/akiradocs/scripts/compile.js @@ -345,8 +345,10 @@ async function createMetaFilesForAllFolders() { } const metaDataPath = path.join(sectionPath, '_meta.json'); - await writeFile(metaDataPath, JSON.stringify(meta, null, 2)); - console.log(`Created meta file: ${metaDataPath}`); + if (!existsSync(metaDataPath)) { + await writeFile(metaDataPath, JSON.stringify(meta, null, 2)); + console.log(`Created meta file: ${metaDataPath}`); + } } } } catch (error) { diff --git a/packages/create-app/package.json b/packages/create-app/package.json index d79cec4..f31b0ad 100644 --- a/packages/create-app/package.json +++ b/packages/create-app/package.json @@ -1,6 +1,6 @@ { "name": "create-akiradocs", - "version": "1.0.38", + "version": "1.0.39", "description": "Create Akira Docs documentation sites with one command", "main": "./dist/index.js", "type": "module",