diff --git a/docs/compiled/de/docs/_meta.json b/docs/compiled/de/docs/_meta.json index affcd59..d6d8024 100644 --- a/docs/compiled/de/docs/_meta.json +++ b/docs/compiled/de/docs/_meta.json @@ -17,23 +17,6 @@ } } }, - "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": { @@ -51,6 +34,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" + } + } + }, "guides": { "title": "Guides", "items": { @@ -60,20 +60,16 @@ } } }, - "gettingStarted": { - "title": "Getting-started", + "editor": { + "title": "Editor", "items": { - "requirements": { - "title": "Systemanforderungen", - "path": "/docs/getting-started/requirements" - }, - "quickstart": { - "title": "Leitfaden für einen schnellen Einstieg", - "path": "/docs/getting-started/quickstart" + "overview": { + "title": "Überblick über den Editor", + "path": "/docs/editor/overview" }, "features": { - "title": "AkiraDocs Funktionen", - "path": "/docs/getting-started/features" + "title": "Editormerkmale", + "path": "/docs/editor/features" } } }, @@ -90,16 +86,20 @@ } } }, - "editor": { - "title": "Editor", + "gettingStarted": { + "title": "Getting-started", "items": { - "overview": { - "title": "Überblick über den Editor", - "path": "/docs/editor/overview" + "requirements": { + "title": "Systemanforderungen", + "path": "/docs/getting-started/requirements" + }, + "quickstart": { + "title": "Leitfaden für einen schnellen Einstieg", + "path": "/docs/getting-started/quickstart" }, "features": { - "title": "Editormerkmale", - "path": "/docs/editor/features" + "title": "AkiraDocs Funktionen", + "path": "/docs/getting-started/features" } } }, diff --git a/docs/compiled/en/docs/_meta.json b/docs/compiled/en/docs/_meta.json index e604b8a..05af779 100644 --- a/docs/compiled/en/docs/_meta.json +++ b/docs/compiled/en/docs/_meta.json @@ -17,20 +17,20 @@ } } }, - "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" } } }, @@ -43,20 +43,50 @@ } } }, - "internationalization": { - "title": "Internationalization", + "gettingStarted": { + "title": "Getting-started", "items": { + "requirements": { + "title": "Requirements", + "path": "/docs/getting-started/requirements" + }, + "quickstart": { + "title": "Quickstart Guide", + "path": "/docs/getting-started/quickstart" + }, + "features": { + "title": "Features", + "path": "/docs/getting-started/features" + } + } + }, + "installation": { + "title": "Installation", + "items": { + "troubleshooting": { + "title": "Troubleshooting", + "path": "/docs/installation/troubleshooting" + }, "setup": { "title": "Setup", - "path": "/docs/internationalization/setup" + "path": "/docs/installation/setup" }, - "managingTranslation": { - "title": "Managing-translation", - "path": "/docs/internationalization/managing-translation" + "configuration": { + "title": "Configuration", + "path": "/docs/installation/configuration" + } + } + }, + "editor": { + "title": "Editor", + "items": { + "overview": { + "title": "Overview", + "path": "/docs/editor/overview" }, - "aiTranslation": { - "title": "Ai-translation", - "path": "/docs/internationalization/ai-translation" + "features": { + "title": "Features", + "path": "/docs/editor/features" } } }, @@ -82,19 +112,6 @@ } } }, - "editor": { - "title": "Editor", - "items": { - "overview": { - "title": "Overview", - "path": "/docs/editor/overview" - }, - "features": { - "title": "Features", - "path": "/docs/editor/features" - } - } - }, "apiReference": { "title": "Api-reference", "items": { @@ -103,22 +120,5 @@ "path": "/docs/api-reference/usage-guide" } } - }, - "gettingStarted": { - "title": "Getting-started", - "items": { - "requirements": { - "title": "Requirements", - "path": "/docs/getting-started/requirements" - }, - "quickstart": { - "title": "Quickstart Guide", - "path": "/docs/getting-started/quickstart" - }, - "features": { - "title": "Features", - "path": "/docs/getting-started/features" - } - } } } \ No newline at end of file diff --git a/docs/compiled/es/docs/_meta.json b/docs/compiled/es/docs/_meta.json index 2d36f6e..e8c0b7a 100644 --- a/docs/compiled/es/docs/_meta.json +++ b/docs/compiled/es/docs/_meta.json @@ -60,23 +60,6 @@ } } }, - "gettingStarted": { - "title": "Getting-started", - "items": { - "requirements": { - "title": "Requisitos del sistema", - "path": "/docs/getting-started/requirements" - }, - "quickstart": { - "title": "Guía de inicio rápido", - "path": "/docs/getting-started/quickstart" - }, - "features": { - "title": "Características de AkiraDocs", - "path": "/docs/getting-started/features" - } - } - }, "editor": { "title": "Editor", "items": { @@ -120,5 +103,22 @@ "path": "/docs/api-reference/usage-guide" } } + }, + "gettingStarted": { + "title": "Getting-started", + "items": { + "requirements": { + "title": "Requisitos del sistema", + "path": "/docs/getting-started/requirements" + }, + "quickstart": { + "title": "Guía de inicio rápido", + "path": "/docs/getting-started/quickstart" + }, + "features": { + "title": "Características de AkiraDocs", + "path": "/docs/getting-started/features" + } + } } } \ No newline at end of file diff --git a/docs/compiled/fr/docs/_meta.json b/docs/compiled/fr/docs/_meta.json index a022f07..8e6baf4 100644 --- a/docs/compiled/fr/docs/_meta.json +++ b/docs/compiled/fr/docs/_meta.json @@ -17,23 +17,6 @@ } } }, - "installation": { - "title": "Installation", - "items": { - "troubleshooting": { - "title": "Voici la traduction en français, en conservant la mise en forme d'origine :\n\nGuide de dépannage", - "path": "/docs/installation/troubleshooting" - }, - "setup": { - "title": "Guide d'installation détaillé", - "path": "/docs/installation/setup" - }, - "configuration": { - "title": "Voici la traduction en français, avec le formatage d'origine conservé :\n\nGuide de configuration", - "path": "/docs/installation/configuration" - } - } - }, "internationalization": { "title": "Internationalization", "items": { @@ -60,6 +43,23 @@ } } }, + "installation": { + "title": "Installation", + "items": { + "troubleshooting": { + "title": "Voici la traduction en français, en conservant la mise en forme d'origine :\n\nGuide de dépannage", + "path": "/docs/installation/troubleshooting" + }, + "setup": { + "title": "Guide d'installation détaillé", + "path": "/docs/installation/setup" + }, + "configuration": { + "title": "Voici la traduction en français, avec le formatage d'origine conservé :\n\nGuide de configuration", + "path": "/docs/installation/configuration" + } + } + }, "gettingStarted": { "title": "Getting-started", "items": { @@ -77,19 +77,6 @@ } } }, - "editor": { - "title": "Editor", - "items": { - "overview": { - "title": "Aperçu de l'éditeur", - "path": "/docs/editor/overview" - }, - "features": { - "title": "Fonctionnalités de l'éditeur", - "path": "/docs/editor/features" - } - } - }, "contributing": { "title": "Contributing", "items": { @@ -103,12 +90,16 @@ } } }, - "contentManagement": { - "title": "Content-management", + "editor": { + "title": "Editor", "items": { - "creatingPages": { - "title": "Voici la traduction en français :\n\nCréer et organiser des pages", - "path": "/docs/content-management/creating-pages" + "overview": { + "title": "Aperçu de l'éditeur", + "path": "/docs/editor/overview" + }, + "features": { + "title": "Fonctionnalités de l'éditeur", + "path": "/docs/editor/features" } } }, @@ -120,5 +111,14 @@ "path": "/docs/api-reference/usage-guide" } } + }, + "contentManagement": { + "title": "Content-management", + "items": { + "creatingPages": { + "title": "Voici la traduction en français :\n\nCréer et organiser des pages", + "path": "/docs/content-management/creating-pages" + } + } } } \ No newline at end of file diff --git a/docs/public/context/en_docs.txt b/docs/public/context/en_docs.txt index 3b2dbe2..bd23552 100644 --- a/docs/public/context/en_docs.txt +++ b/docs/public/context/en_docs.txt @@ -251,6 +251,229 @@ Context-aware translations Technical term preservation Format maintenance ------------- +[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: +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 +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 +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/guides/analytics.json] Title: Analytics Integration Learn how to add analytics tracking to your documentation @@ -501,228 +724,98 @@ Git integration Change history Rollback capabilities ------------- -[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: -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 -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: +[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 -3. Create Environment File -The environment file is created automatically. You can modify it at `.env.local` -4. Start Development Server -Code example: + +# Start development server 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 +Contribution Guidelines +Types of Contributions +Bug fixes +Feature additions +Documentation improvements +Translation help +Issue reporting +Pull Request Process 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 +2. Create feature branch +3. Make changes +4. Submit pull request +Commit Messages Code example: -NODE_ENV=production -DEBUG=false +# 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: -NODE_ENV=test -TEST_MODE=true +# 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/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/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/content-management/creating-pages.json] Title: Creating and Organizing Pages @@ -854,97 +947,4 @@ 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/packages/akiradocs/compiled/en/articles/_meta.json b/packages/akiradocs/compiled/en/articles/_meta.json index 24f7566..dd4c6fe 100644 --- a/packages/akiradocs/compiled/en/articles/_meta.json +++ b/packages/akiradocs/compiled/en/articles/_meta.json @@ -2,7 +2,7 @@ "defaultRoute": "/articles/welcome", "welcome": { "title": "Welcome to Akira Doc", - "path": "/articles/welcome" + "path": "/en/articles/welcome" }, "template": { "title": "Test Blog Post", @@ -10,6 +10,6 @@ }, "ai_integration": { "title": "Ai Integration", - "path": "/articles/ai_integration" + "path": "/en/articles/ai_integration" } } \ No newline at end of file diff --git a/packages/akiradocs/compiled/en/docs/_meta.json b/packages/akiradocs/compiled/en/docs/_meta.json index e7a65b1..2ae58e1 100644 --- a/packages/akiradocs/compiled/en/docs/_meta.json +++ b/packages/akiradocs/compiled/en/docs/_meta.json @@ -2,7 +2,7 @@ "defaultRoute": "/docs/introduction", "introduction": { "title": "Introduction", - "path": "/docs/introduction" + "path": "/en/docs/introduction" }, "guides": { "title": "Guides", diff --git a/packages/akiradocs/compiled/en/docs/getting-started/quickstart.json b/packages/akiradocs/compiled/en/docs/getting-started/quickstart.json index 857f709..7d37381 100644 --- a/packages/akiradocs/compiled/en/docs/getting-started/quickstart.json +++ b/packages/akiradocs/compiled/en/docs/getting-started/quickstart.json @@ -14,15 +14,10 @@ { "id": "1", "type": "paragraph", - "content": "Get up and running with Akira Docs in minutes" - }, - { - "id": "2", - "type": "paragraph", "content": "Follow these steps to start using Akira Docs for your documentation needs." }, { - "id": "3", + "id": "2", "type": "code", "content": "bash\ngit clone https://github.com/your-org/akira-docs-template\ncd akira-docs-template\nnpm install\nnpm run dev", "metadata": { @@ -31,9 +26,13 @@ } }, { - "id": "4", - "type": "paragraph", - "content": ":::warning Prerequisites\nMake sure you have Node.js 16 or higher installed on your system.\n:::" + "id": "3", + "type": "callout", + "content": "Make sure you have Node.js 16 or higher installed on your system.", + "metadata": { + "type": "warning", + "title": "Warning" + } } ] } \ No newline at end of file diff --git a/packages/akiradocs/public/context/en_docs.txt b/packages/akiradocs/public/context/en_docs.txt index b1c2505..c52da6a 100644 --- a/packages/akiradocs/public/context/en_docs.txt +++ b/packages/akiradocs/public/context/en_docs.txt @@ -117,7 +117,6 @@ This provides a complete analytics integration that's easy for users to set up a ------------- [Document: docs/getting-started/quickstart.json] Title: Quickstart Guide -Get up and running with Akira Docs in minutes Follow these steps to start using Akira Docs for your documentation needs. Code example: bash @@ -125,7 +124,5 @@ git clone https://github.com/your-org/akira-docs-template cd akira-docs-template npm install npm run dev -:::warning Prerequisites -Make sure you have Node.js 16 or higher installed on your system. -::: +Warning: Make sure you have Node.js 16 or higher installed on your system. ------------- \ No newline at end of file diff --git a/packages/akiradocs/src/template.json b/packages/akiradocs/src/template.json index 1170ced..19596e1 100644 --- a/packages/akiradocs/src/template.json +++ b/packages/akiradocs/src/template.json @@ -3,10 +3,13 @@ "description": "A test blog post to demonstrate all block types.", "author": "Anonymous", "ogImage": "/og-image.png", + "ogImageDescription": "A test blog post to demonstrate all block types.", "publishDate": "2024-10-29", "modifiedDate": "2024-10-29", "category": "Test Category", "keywords": ["test", "blog", "post"], + "file_slug": "test-blog-post", + "section": "Features/Automations", "blocks": [ { "id": "1",