diff --git a/docs/compiled/de/docs/_meta.json b/docs/compiled/de/docs/_meta.json index 90a88c2..0b9cfad 100644 --- a/docs/compiled/de/docs/_meta.json +++ b/docs/compiled/de/docs/_meta.json @@ -69,6 +69,14 @@ "ai-features": { "title": "KI-Funktionen", "path": "/docs/editor/ai-features" + }, + "gettingStarted": { + "title": "Erste Schritte mit dem Editor", + "path": "/docs/editor/getting-started" + }, + "aiFeatures": { + "title": "KI-Funktionen", + "path": "/docs/editor/ai-features" } } }, diff --git a/docs/compiled/en/articles/importance_of_documentation.json b/docs/compiled/en/articles/importance_of_documentation.json new file mode 100644 index 0000000..7d56085 --- /dev/null +++ b/docs/compiled/en/articles/importance_of_documentation.json @@ -0,0 +1,477 @@ +{ + "title": "The Critical Importance of Documentation in Modern Software Development", + "description": "Explore why documentation is crucial for software success, customer experience, and AI development in today's tech landscape.", + "author": "Saurav Panda", + "publishDate": "2024-11-10T00:00:00.000Z", + "modifiedDate": "2024-11-10T00:00:00.000Z", + "category": "Technical Insights", + "keywords": [ + "Documentation", + "Developer Experience", + "Customer Success", + "AI Training", + "Open Source", + "SaaS" + ], + "blocks": [ + { + "id": "1", + "type": "paragraph", + "content": "Having spent years building developer tools, I've witnessed firsthand how documentation can make or break a software project. It's fascinating how often we prioritize shipping features while pushing documentation to \"we'll do it later.\" But here's the thing - that \"later\" often comes at a much higher cost than we imagine." + }, + { + "id": "2", + "type": "heading", + "content": "The Real Pain of Poor Documentation", + "metadata": { + "level": 2 + } + }, + { + "id": "3", + "type": "paragraph", + "content": "I remember joining a startup where tribal knowledge was the norm. What should have been a two-week onboarding turned into months of piecing together how things worked. This isn't just my story - I've heard similar experiences from countless developers. Here's what we're all dealing with:" + }, + { + "id": "4", + "type": "heading", + "content": "The Daily Developer Struggle", + "metadata": { + "level": 3 + } + }, + { + "id": "5", + "type": "list", + "content": [ + "We spend nearly a third of our time just trying to understand existing code", + "New team members feel lost and overwhelmed", + "That quick fix? It takes hours because nobody documented the gotchas" + ], + "metadata": { + "listType": "unordered" + } + }, + { + "id": "6", + "type": "heading", + "content": "The Customer's Perspective", + "metadata": { + "level": 3 + } + }, + { + "id": "7", + "type": "paragraph", + "content": "I've been on both sides of this - as a developer and as a user. When documentation is poor:" + }, + { + "id": "8", + "type": "list", + "content": [ + "Users get frustrated and simply give up", + "Support teams get flooded with basic questions", + "Customer success becomes more about firefighting than growth", + "Users churn because they can't unlock your product's full potential" + ], + "metadata": { + "listType": "unordered" + } + }, + { + "id": "9", + "type": "heading", + "content": "The Hidden Costs of Poor Documentation", + "metadata": { + "level": 2 + } + }, + { + "id": "10", + "type": "heading", + "content": "Developer Time and Resources", + "metadata": { + "level": 3 + } + }, + { + "id": "11", + "type": "list", + "content": [ + "Engineers spend up to 30% of their time searching for information or trying to understand code", + "Onboarding new team members takes significantly longer without proper documentation", + "Technical debt accumulates as tribal knowledge becomes the primary source of information" + ], + "metadata": { + "listType": "unordered" + } + }, + { + "id": "12", + "type": "heading", + "content": "Customer Experience Impact", + "metadata": { + "level": 3 + } + }, + { + "id": "13", + "type": "list", + "content": [ + "Users abandon products due to confusion and frustration", + "Support tickets increase, raising operational costs", + "Customer success teams struggle to provide accurate assistance", + "Higher churn rates due to poor user experience" + ], + "metadata": { + "listType": "unordered" + } + }, + { + "id": "14", + "type": "heading", + "content": "AI and Machine Learning Challenges", + "metadata": { + "level": 3 + } + }, + { + "id": "15", + "type": "list", + "content": [ + "LLMs trained on outdated or incorrect documentation spread misinformation", + "AI assistants struggle to provide accurate, context-aware help", + "The gap between code reality and documentation widens as software evolves" + ], + "metadata": { + "listType": "unordered" + } + }, + { + "id": "16", + "type": "heading", + "content": "Documentation as a Growth Driver", + "metadata": { + "level": 2 + } + }, + { + "id": "17", + "type": "heading", + "content": "Enhanced Customer Experience", + "metadata": { + "level": 3 + } + }, + { + "id": "18", + "type": "list", + "content": [ + "Clear documentation reduces friction in user adoption", + "Self-service support becomes more effective", + "Users feel more confident and empowered", + "Higher customer satisfaction and retention rates" + ], + "metadata": { + "listType": "unordered" + } + }, + { + "id": "19", + "type": "heading", + "content": "SEO and Brand Authority", + "metadata": { + "level": 3 + } + }, + { + "id": "20", + "type": "list", + "content": [ + "Well-documented products rank better in search results", + "Documentation pages serve as valuable content marketing", + "Establishes thought leadership in the industry", + "Builds trust with potential customers" + ], + "metadata": { + "listType": "unordered" + } + }, + { + "id": "21", + "type": "heading", + "content": "Open Source Success", + "metadata": { + "level": 3 + } + }, + { + "id": "22", + "type": "list", + "content": [ + "Quality documentation attracts more contributors", + "Increases project adoption and community engagement", + "Makes your project more discoverable", + "Facilitates collaboration across time zones" + ], + "metadata": { + "listType": "unordered" + } + }, + { + "id": "23", + "type": "heading", + "content": "The AI Documentation Challenge", + "metadata": { + "level": 2 + } + }, + { + "id": "24", + "type": "heading", + "content": "Current Problems", + "metadata": { + "level": 3 + } + }, + { + "id": "25", + "type": "list", + "content": [ + "AI models learning from outdated or incorrect documentation", + "Inability to verify the accuracy of AI-generated responses", + "Disconnect between documentation and actual code implementation", + "Difficulty in maintaining up-to-date documentation" + ], + "metadata": { + "listType": "unordered" + } + }, + { + "id": "26", + "type": "heading", + "content": "Future Solutions", + "metadata": { + "level": 3 + } + }, + { + "id": "27", + "type": "list", + "content": [ + "AI-powered documentation generation and validation", + "Real-time documentation updates based on code changes", + "Automated quality scoring and improvement suggestions", + "Enhanced search and discovery through AI understanding" + ], + "metadata": { + "listType": "unordered" + } + }, + { + "id": "28", + "type": "heading", + "content": "Best Practices for Modern Documentation", + "metadata": { + "level": 2 + } + }, + { + "id": "29", + "type": "heading", + "content": "Structure and Organization", + "metadata": { + "level": 3 + } + }, + { + "id": "30", + "type": "list", + "content": [ + "Clear hierarchy and navigation", + "Consistent formatting and style", + "Version control and change tracking", + "Regular audits and updates" + ], + "metadata": { + "listType": "unordered" + } + }, + { + "id": "31", + "type": "heading", + "content": "Content Quality", + "metadata": { + "level": 3 + } + }, + { + "id": "32", + "type": "list", + "content": [ + "Code examples and use cases", + "Step-by-step tutorials", + "Troubleshooting guides", + "API reference documentation" + ], + "metadata": { + "listType": "unordered" + } + }, + { + "id": "33", + "type": "heading", + "content": "User-Centric Approach", + "metadata": { + "level": 3 + } + }, + { + "id": "34", + "type": "list", + "content": [ + "Different documentation levels for various user types", + "Interactive examples and playgrounds", + "Feedback mechanisms", + "Community contribution guidelines" + ], + "metadata": { + "listType": "unordered" + } + }, + { + "id": "35", + "type": "heading", + "content": "The Business Case for Documentation", + "metadata": { + "level": 2 + } + }, + { + "id": "36", + "type": "heading", + "content": "ROI Metrics", + "metadata": { + "level": 3 + } + }, + { + "id": "37", + "type": "list", + "content": [ + "Reduced support costs", + "Faster user onboarding", + "Improved team productivity", + "Higher customer satisfaction scores" + ], + "metadata": { + "listType": "unordered" + } + }, + { + "id": "38", + "type": "heading", + "content": "Competitive Advantage", + "metadata": { + "level": 3 + } + }, + { + "id": "39", + "type": "list", + "content": [ + "Better market positioning", + "Increased user trust", + "Faster product adoption", + "Strong community engagement" + ], + "metadata": { + "listType": "unordered" + } + }, + { + "id": "40", + "type": "heading", + "content": "Why We Built Akiradocs", + "metadata": { + "level": 2 + } + }, + { + "id": "41", + "type": "paragraph", + "content": "After experiencing these documentation challenges repeatedly, we created Akiradocs as an alternative to existing solutions like Nextra. While Nextra provides a solid foundation for documentation sites, we wanted to go further. With Akiradocs, you get:" + }, + { + "id": "42", + "type": "list", + "content": [ + "AI-Powered Documentation: Not just a static site generator, but an intelligent system that helps you create, maintain, and improve your docs", + "Real-Time Validation: Catch outdated or incorrect documentation before your users do", + "Smart Search and Discovery: Help users find exactly what they need, when they need it", + "Automated Quality Checks: Get suggestions for improving your documentation's clarity and completeness", + "Simple Migration: Easy transition from Nextra or other documentation platforms" + ], + "metadata": { + "listType": "unordered" + } + }, + { + "id": "43", + "type": "heading", + "content": "The Future of Documentation", + "metadata": { + "level": 2 + } + }, + { + "id": "44", + "type": "paragraph", + "content": "Having worked with various documentation tools and seen their limitations, I'm excited about where we're heading. Imagine documentation that:" + }, + { + "id": "45", + "type": "list", + "content": [ + "Updates itself as your code evolves", + "Learns from how users interact with it", + "Provides different levels of detail based on user expertise", + "Serves as a reliable knowledge source for AI models" + ], + "metadata": { + "listType": "unordered" + } + }, + { + "id": "46", + "type": "heading", + "content": "Conclusion", + "metadata": { + "level": 2 + } + }, + { + "id": "47", + "type": "paragraph", + "content": "Documentation is not just a technical necessity but a strategic asset that impacts every aspect of software success. As AI continues to reshape the technology landscape, the importance of accurate, up-to-date documentation becomes even more critical. Investing in documentation today means building a stronger foundation for tomorrow's success." + }, + { + "id": "48", + "type": "heading", + "content": "Getting Started", + "metadata": { + "level": 2 + } + }, + { + "id": "49", + "type": "paragraph", + "content": "I've been through the documentation improvement journey multiple times, and here's what I've learned works best:\n1. Start with an honest audit of your current docs\n2. Focus on your users' biggest pain points first\n3. Build a sustainable documentation culture\n4. Use tools like Akiradocs to automate and improve\n5. Keep measuring and iterating" + }, + { + "id": "50", + "type": "paragraph", + "content": "Remember, great documentation isn't about perfection - it's about continuous improvement. Start where you are, use the tools available, and keep making it better. Your future self (and your users) will thank you." + } + ] +} \ No newline at end of file diff --git a/docs/compiled/en/docs/_meta.json b/docs/compiled/en/docs/_meta.json index 8d5b152..4a585ba 100644 --- a/docs/compiled/en/docs/_meta.json +++ b/docs/compiled/en/docs/_meta.json @@ -69,6 +69,14 @@ "ai-features": { "title": "AI Features", "path": "/docs/editor/ai-features" + }, + "gettingStarted": { + "title": "Getting Started with the Editor", + "path": "/docs/editor/getting-started" + }, + "aiFeatures": { + "title": "AI Features", + "path": "/docs/editor/ai-features" } } }, diff --git a/docs/compiled/en/docs/editor/features.json b/docs/compiled/en/docs/editor/features.json index ba135ff..8b78b6d 100644 --- a/docs/compiled/en/docs/editor/features.json +++ b/docs/compiled/en/docs/editor/features.json @@ -1,46 +1,46 @@ { "title": "Editor Features", - "description": "Detailed overview of AkiraDocs editor capabilities and features", + "description": "", "author": "Akira Team", "publishDate": "2024-11-26T00:00:00.000Z", "modifiedDate": "2024-11-26T00:00:00.000Z", "category": "Editor", "keywords": [ - "Features", - "Capabilities", - "Editor Functions", - "Tools" + "Editor Features", + "Blocks", + "Formatting" ], "blocks": [ { "id": "1", + "type": "paragraph", + "content": "Detailed overview of AkiraDocs editor capabilities and features." + }, + { + "id": "2", "type": "heading", - "content": "Drag and Drop", + "content": "Block System", "metadata": { "level": 2 } }, - { - "id": "2", - "type": "paragraph", - "content": "The editor features a powerful drag-and-drop system powered by dnd-kit, allowing intuitive block reordering and organization. Simply click and drag any block to reposition it within your document." - }, { "id": "3", "type": "heading", - "content": "File Management", + "content": "Text Formatting", "metadata": { - "level": 2 + "level": 3 } }, { "id": "4", "type": "list", "content": [ - "Automatic file saving and versioning", - "Image optimization and management", - "File upload support for various media types", - "Integrated file browser and explorer" + "Basic Formatting", + "Bold, italic, underline", + "Strikethrough", + "Highlight", + "Code inline" ], "metadata": { "listType": "unordered" @@ -48,16 +48,158 @@ }, { "id": "5", + "type": "list", + "content": [ + "Advanced Formatting", + "Custom colors", + "Multiple fonts", + "Text alignment", + "Indentation" + ], + "metadata": { + "listType": "unordered" + } + }, + { + "id": "6", + "type": "heading", + "content": "Content Blocks", + "metadata": { + "level": 3 + } + }, + { + "id": "7", + "type": "heading", + "content": "Rich Text", + "metadata": { + "level": 4 + } + }, + { + "id": "8", + "type": "code", + "content": "# Heading 1\n## Heading 2\n> Blockquote\n- Bullet list\n1. Numbered list", + "metadata": { + "language": "markdown", + "showLineNumbers": true + } + }, + { + "id": "9", "type": "heading", - "content": "Real-time Collaboration", + "content": "Code Blocks", + "metadata": { + "level": 4 + } + }, + { + "id": "10", + "type": "code", + "content": "// Syntax highlighting\nconsole.log('Hello World');", + "metadata": { + "language": "javascript", + "showLineNumbers": true + } + }, + { + "id": "11", + "type": "heading", + "content": "Media Blocks", + "metadata": { + "level": 4 + } + }, + { + "id": "12", + "type": "list", + "content": [ + "Image upload and embedding", + "Video embedding", + "File attachments", + "Interactive embeds" + ], + "metadata": { + "listType": "unordered" + } + }, + { + "id": "13", + "type": "heading", + "content": "AI Features", "metadata": { "level": 2 } }, { - "id": "6", - "type": "paragraph", - "content": "Multiple users can work on the same document simultaneously, with real-time updates and conflict resolution. Changes are automatically synchronized across all connected clients." + "id": "14", + "type": "heading", + "content": "Content Enhancement", + "metadata": { + "level": 3 + } + }, + { + "id": "15", + "type": "list", + "content": [ + "Grammar and style suggestions", + "Content optimization", + "SEO recommendations", + "Translation assistance" + ], + "metadata": { + "listType": "unordered" + } + }, + { + "id": "16", + "type": "heading", + "content": "Smart Formatting", + "metadata": { + "level": 3 + } + }, + { + "id": "17", + "type": "list", + "content": [ + "Auto-formatting", + "Smart lists", + "Table formatting", + "Code block language detection" + ], + "metadata": { + "listType": "unordered" + } + }, + { + "id": "18", + "type": "heading", + "content": "Collaboration Features", + "metadata": { + "level": 2 + } + }, + { + "id": "19", + "type": "heading", + "content": "Version Control", + "metadata": { + "level": 3 + } + }, + { + "id": "20", + "type": "list", + "content": [ + "Git integration", + "Change history", + "Rollback capabilities" + ], + "metadata": { + "listType": "unordered" + } } ] } \ No newline at end of file diff --git a/docs/compiled/en/docs/editor/overview.json b/docs/compiled/en/docs/editor/overview.json index dd97a4b..db11b36 100644 --- a/docs/compiled/en/docs/editor/overview.json +++ b/docs/compiled/en/docs/editor/overview.json @@ -1,91 +1,185 @@ { "title": "Editor Overview", - "description": "A comprehensive overview of the AkiraDocs block-based editor", + "description": "", "author": "Akira Team", "publishDate": "2024-11-26T00:00:00.000Z", "modifiedDate": "2024-11-26T00:00:00.000Z", "category": "Editor", "keywords": [ "Editor", - "Block-based", - "Overview", - "Introduction" + "Notion-like", + "Interface" ], "blocks": [ { "id": "1", "type": "paragraph", - "content": "AkiraDocs features a modern, block-based editor that combines the simplicity of visual editing with the power of Markdown. Built for both developers and content creators, it offers a flexible and intuitive way to create and manage documentation." + "content": "AkiraDocs features a modern, Notion-like editor that combines the simplicity of block-based editing with the power of Markdown." }, { "id": "2", "type": "heading", - "content": "Key Features", + "content": "Editor Interface", "metadata": { "level": 2 } }, { "id": "3", + "type": "heading", + "content": "Main Components", + "metadata": { + "level": 3 + } + }, + { + "id": "4", "type": "list", "content": [ - "Block-based editing with drag-and-drop support", - "Rich text formatting with Markdown support", - "Real-time collaboration capabilities", - "Extensible block system", - "Built-in version control", - "AI-powered content assistance" + "Toolbar: Quick access to formatting options and block types", + "Content Area: Block-based editing space", + "Sidebar: Navigation and document structure", + "Command Palette: Quick commands (Ctrl/Cmd + P)" ], "metadata": { "listType": "unordered" } }, { - "id": "4", + "id": "5", "type": "heading", - "content": "System Architecture", + "content": "Block Structure", + "metadata": { + "level": 3 + } + }, + { + "id": "6", + "type": "paragraph", + "content": "Each content element is a block that can be:" + }, + { + "id": "7", + "type": "list", + "content": [ + "Dragged and dropped to reorganize", + "Converted between different types", + "Duplicated or deleted", + "Nested within other blocks" + ], + "metadata": { + "listType": "unordered" + } + }, + { + "id": "8", + "type": "heading", + "content": "Getting Started", "metadata": { "level": 2 } }, { - "id": "5", + "id": "9", + "type": "heading", + "content": "Creating Content", + "metadata": { + "level": 3 + } + }, + { + "id": "10", "type": "paragraph", - "content": "The editor is built on a modern stack using React and Next.js, with a modular architecture that separates concerns between block management, content handling, and UI components." + "content": "1. Click the '+' button or press '/' to add a new block\n2. Choose block type from the popup menu\n3. Start typing or add content" }, { - "id": "6", + "id": "11", "type": "heading", - "content": "Core Components", + "content": "Basic Operations", "metadata": { "level": 3 } }, { - "id": "7", + "id": "12", + "type": "code", + "content": "/ → Open block menu\n⌘/Ctrl + P → Command palette\n⌘/Ctrl + / → Show keyboard shortcuts\n↑↓ → Navigate between blocks", + "metadata": { + "language": "plaintext", + "showLineNumbers": true + } + }, + { + "id": "13", + "type": "heading", + "content": "Block Types", + "metadata": { + "level": 2 + } + }, + { + "id": "14", + "type": "heading", + "content": "Text Blocks", + "metadata": { + "level": 3 + } + }, + { + "id": "15", "type": "list", "content": [ - "Block Manager: Handles block creation, deletion, and ordering", - "Content Editor: Manages text input and formatting", - "File System: Handles content persistence and file management", - "UI Components: Provides the user interface elements" + "Paragraphs", + "Headings (H1-H6)", + "Lists (Bulleted, Numbered)", + "Quotes", + "Callouts" ], "metadata": { "listType": "unordered" } }, { - "id": "8", + "id": "16", "type": "heading", - "content": "Getting Started", + "content": "Rich Media", "metadata": { - "level": 2 + "level": 3 } }, { - "id": "9", - "type": "paragraph", - "content": "To begin using the editor, ensure you have Node.js 18+ installed. The editor is included by default in AkiraDocs installations. For detailed setup instructions, see the Getting Started guide." + "id": "17", + "type": "list", + "content": [ + "Images", + "Videos", + "Embeds", + "Files", + "Code blocks" + ], + "metadata": { + "listType": "unordered" + } + }, + { + "id": "18", + "type": "heading", + "content": "Special Blocks", + "metadata": { + "level": 3 + } + }, + { + "id": "19", + "type": "list", + "content": [ + "Tables (Coming Soon)", + "Dividers", + "Custom components (Coming Soon)" + ], + "metadata": { + "listType": "unordered" + } } ] } \ No newline at end of file diff --git a/docs/compiled/es/docs/_meta.json b/docs/compiled/es/docs/_meta.json index 8202095..37c1b7c 100644 --- a/docs/compiled/es/docs/_meta.json +++ b/docs/compiled/es/docs/_meta.json @@ -69,6 +69,14 @@ "ai-features": { "title": "Características de IA", "path": "/docs/editor/ai-features" + }, + "gettingStarted": { + "title": "Comenzando con el editor", + "path": "/docs/editor/getting-started" + }, + "aiFeatures": { + "title": "Características de IA", + "path": "/docs/editor/ai-features" } } }, diff --git a/docs/compiled/fr/docs/_meta.json b/docs/compiled/fr/docs/_meta.json index ecae0d5..0678dcf 100644 --- a/docs/compiled/fr/docs/_meta.json +++ b/docs/compiled/fr/docs/_meta.json @@ -69,6 +69,14 @@ "ai-features": { "title": "Fonctionnalités d'IA", "path": "/docs/editor/ai-features" + }, + "gettingStarted": { + "title": "Premiers pas avec l'éditeur", + "path": "/docs/editor/getting-started" + }, + "aiFeatures": { + "title": "Fonctionnalités d'IA", + "path": "/docs/editor/ai-features" } } }, diff --git a/docs/compiled/manifest.json b/docs/compiled/manifest.json index 0f79b1f..ad1f5ca 100644 --- a/docs/compiled/manifest.json +++ b/docs/compiled/manifest.json @@ -1,16 +1,20 @@ { "files": [ + ".DS_Store", + "de/.DS_Store", "de/api/apiSpec.json", "de/articles/_meta.json", "de/articles/ai_integration.json", - "de/articles/template.json", "de/articles/welcome.json", "de/docs/_meta.json", "de/docs/api-reference/usage-guide.json", "de/docs/content-management/creating-pages.json", "de/docs/contributing/code-of-conduct.json", "de/docs/contributing/how-to-contribute.json", + "de/docs/editor/ai-features.json", + "de/docs/editor/blocks.json", "de/docs/editor/features.json", + "de/docs/editor/getting-started.json", "de/docs/editor/overview.json", "de/docs/getting-started/features.json", "de/docs/getting-started/quickstart.json", @@ -25,11 +29,13 @@ "de/docs/introduction.json", "de/docs/seo-and-performance/robot-txt.json", "de/docs/seo-and-performance/sitemap-generation.json", + "en/.DS_Store", "en/api/apiSpec.json", "en/articles/_meta.json", "en/articles/ai_integration.json", - "en/articles/template.json", + "en/articles/importance_of_documentation.json", "en/articles/welcome.json", + "en/docs/.DS_Store", "en/docs/_meta.json", "en/docs/api-reference/_meta.json", "en/docs/api-reference/usage-guide.json", @@ -39,7 +45,10 @@ "en/docs/contributing/code-of-conduct.json", "en/docs/contributing/how-to-contribute.json", "en/docs/editor/_meta.json", + "en/docs/editor/ai-features.json", + "en/docs/editor/blocks.json", "en/docs/editor/features.json", + "en/docs/editor/getting-started.json", "en/docs/editor/overview.json", "en/docs/getting-started/_meta.json", "en/docs/getting-started/features.json", @@ -59,17 +68,20 @@ "en/docs/seo-and-performance/_meta.json", "en/docs/seo-and-performance/robot-txt.json", "en/docs/seo-and-performance/sitemap-generation.json", + "es/.DS_Store", "es/api/apiSpec.json", "es/articles/_meta.json", "es/articles/ai_integration.json", - "es/articles/template.json", "es/articles/welcome.json", "es/docs/_meta.json", "es/docs/api-reference/usage-guide.json", "es/docs/content-management/creating-pages.json", "es/docs/contributing/code-of-conduct.json", "es/docs/contributing/how-to-contribute.json", + "es/docs/editor/ai-features.json", + "es/docs/editor/blocks.json", "es/docs/editor/features.json", + "es/docs/editor/getting-started.json", "es/docs/editor/overview.json", "es/docs/getting-started/features.json", "es/docs/getting-started/quickstart.json", @@ -84,17 +96,20 @@ "es/docs/introduction.json", "es/docs/seo-and-performance/robot-txt.json", "es/docs/seo-and-performance/sitemap-generation.json", + "fr/.DS_Store", "fr/api/apiSpec.json", "fr/articles/_meta.json", "fr/articles/ai_integration.json", - "fr/articles/template.json", "fr/articles/welcome.json", "fr/docs/_meta.json", "fr/docs/api-reference/usage-guide.json", "fr/docs/content-management/creating-pages.json", "fr/docs/contributing/code-of-conduct.json", "fr/docs/contributing/how-to-contribute.json", + "fr/docs/editor/ai-features.json", + "fr/docs/editor/blocks.json", "fr/docs/editor/features.json", + "fr/docs/editor/getting-started.json", "fr/docs/editor/overview.json", "fr/docs/getting-started/features.json", "fr/docs/getting-started/quickstart.json", diff --git a/docs/public/context/en_docs.txt b/docs/public/context/en_docs.txt index bd23552..8078524 100644 --- a/docs/public/context/en_docs.txt +++ b/docs/public/context/en_docs.txt @@ -33,27 +33,134 @@ Compliance documentation Training materials ------------- [Document: articles/welcome.json] -Title: Welcome to Akira Doc -Get started with Akira Docs - Next-gen documentation powered by AI -Welcome to Akira Docs, the next-generation documentation platform powered by AI. This template will help you get started with creating your own documentation. -Key Features -Easy to customize -AI-powered search -Block-based content system -Responsive design -Getting Started: Start by customizing this template to match your project's needs! +Title: Welcome to Cloud Code AI: Building the Future of AI-Powered Documentation +Join us on our journey to revolutionizing customer experience with advanced AI documentation tools. +At Cloud Code AI, our mission is to harness the power of artificial intelligence to transform the way developers and organizations operate. Our journey began with the ambitious goal of building an AI DevOps engineer, Kaizen, designed to streamline and automate complex development operations. You can explore Kaizen at [git.new/kaizen](https://git.new/cloudcodeai). +Our Evolution +While our initial focus on creating an AI-driven DevOps engineer laid a strong foundation, we recognized the immense potential in enhancing customer experience through intelligent documentation. This insight led us to pivot and develop an AI-powered documentation tool, Akiradocs. Discover Akiradocs at [git.new/akiradocs](https://git.new/akiradocs). +What We're Building +Our current project, Akiradocs, is an AI-powered documentation tool designed to simplify and enhance the creation, management, and utilization of documentation. By leveraging AI, we aim to provide: +Smart Content Generation: Automatically generate high-quality documentation based on your project details. +AI-Powered Search: Enable intuitive and intelligent search capabilities to help users find the information they need quickly. +Personalized User Experience: Tailor the documentation experience to individual user needs, making information more accessible and actionable. +Seamless Integration: Easily integrate with your existing tools and workflows to ensure a smooth and efficient documentation process. +Future Innovations +We're excited about the future of documentation, and we're working on groundbreaking features: +Automated Documentation Generation: Using advanced AI to automatically create comprehensive documentation from your codebase, ensuring your docs stay in sync with your code. +Documentation Quality Scoring: Implementing an intelligent scoring system that evaluates and helps improve documentation quality, completeness, and clarity. +LLM Knowledge Integration: Developing a revolutionary approach for Large Language Models to learn and understand software systems through documentation, making AI assistance more accurate and context-aware. +Our Vision +At Cloud Code AI, we are committed to improving customer experience by making documentation more accessible, interactive, and intelligent. Our AI-driven approach ensures that both developers and end-users can interact with documentation more efficiently, leading to better product understanding and satisfaction. +Get Started +We invite you to join us on this exciting journey. Whether you're a developer looking for smarter documentation tools or an organization aiming to enhance your customer experience, Cloud Code AI has the solutions you need. Stay tuned for updates, and feel free to reach out to our team for more information. ------------- -[Document: articles/template.json] -Title: Test Blog Post -A test blog post to demonstrate all block types. -Example Heading Sample1 -This paragraph is part of the test blog post. It demonstrates the paragraph block. -Code example: -console.log('Testing all blocks'); -Item 1 -Item 2 -Item 3 -Important: This is an important callout message. +[Document: articles/importance_of_documentation.json] +Title: The Critical Importance of Documentation in Modern Software Development +Explore why documentation is crucial for software success, customer experience, and AI development in today's tech landscape. +Having spent years building developer tools, I've witnessed firsthand how documentation can make or break a software project. It's fascinating how often we prioritize shipping features while pushing documentation to "we'll do it later." But here's the thing - that "later" often comes at a much higher cost than we imagine. +The Real Pain of Poor Documentation +I remember joining a startup where tribal knowledge was the norm. What should have been a two-week onboarding turned into months of piecing together how things worked. This isn't just my story - I've heard similar experiences from countless developers. Here's what we're all dealing with: +The Daily Developer Struggle +We spend nearly a third of our time just trying to understand existing code +New team members feel lost and overwhelmed +That quick fix? It takes hours because nobody documented the gotchas +The Customer's Perspective +I've been on both sides of this - as a developer and as a user. When documentation is poor: +Users get frustrated and simply give up +Support teams get flooded with basic questions +Customer success becomes more about firefighting than growth +Users churn because they can't unlock your product's full potential +The Hidden Costs of Poor Documentation +Developer Time and Resources +Engineers spend up to 30% of their time searching for information or trying to understand code +Onboarding new team members takes significantly longer without proper documentation +Technical debt accumulates as tribal knowledge becomes the primary source of information +Customer Experience Impact +Users abandon products due to confusion and frustration +Support tickets increase, raising operational costs +Customer success teams struggle to provide accurate assistance +Higher churn rates due to poor user experience +AI and Machine Learning Challenges +LLMs trained on outdated or incorrect documentation spread misinformation +AI assistants struggle to provide accurate, context-aware help +The gap between code reality and documentation widens as software evolves +Documentation as a Growth Driver +Enhanced Customer Experience +Clear documentation reduces friction in user adoption +Self-service support becomes more effective +Users feel more confident and empowered +Higher customer satisfaction and retention rates +SEO and Brand Authority +Well-documented products rank better in search results +Documentation pages serve as valuable content marketing +Establishes thought leadership in the industry +Builds trust with potential customers +Open Source Success +Quality documentation attracts more contributors +Increases project adoption and community engagement +Makes your project more discoverable +Facilitates collaboration across time zones +The AI Documentation Challenge +Current Problems +AI models learning from outdated or incorrect documentation +Inability to verify the accuracy of AI-generated responses +Disconnect between documentation and actual code implementation +Difficulty in maintaining up-to-date documentation +Future Solutions +AI-powered documentation generation and validation +Real-time documentation updates based on code changes +Automated quality scoring and improvement suggestions +Enhanced search and discovery through AI understanding +Best Practices for Modern Documentation +Structure and Organization +Clear hierarchy and navigation +Consistent formatting and style +Version control and change tracking +Regular audits and updates +Content Quality +Code examples and use cases +Step-by-step tutorials +Troubleshooting guides +API reference documentation +User-Centric Approach +Different documentation levels for various user types +Interactive examples and playgrounds +Feedback mechanisms +Community contribution guidelines +The Business Case for Documentation +ROI Metrics +Reduced support costs +Faster user onboarding +Improved team productivity +Higher customer satisfaction scores +Competitive Advantage +Better market positioning +Increased user trust +Faster product adoption +Strong community engagement +Why We Built Akiradocs +After experiencing these documentation challenges repeatedly, we created Akiradocs as an alternative to existing solutions like Nextra. While Nextra provides a solid foundation for documentation sites, we wanted to go further. With Akiradocs, you get: +AI-Powered Documentation: Not just a static site generator, but an intelligent system that helps you create, maintain, and improve your docs +Real-Time Validation: Catch outdated or incorrect documentation before your users do +Smart Search and Discovery: Help users find exactly what they need, when they need it +Automated Quality Checks: Get suggestions for improving your documentation's clarity and completeness +Simple Migration: Easy transition from Nextra or other documentation platforms +The Future of Documentation +Having worked with various documentation tools and seen their limitations, I'm excited about where we're heading. Imagine documentation that: +Updates itself as your code evolves +Learns from how users interact with it +Provides different levels of detail based on user expertise +Serves as a reliable knowledge source for AI models +Conclusion +Documentation is not just a technical necessity but a strategic asset that impacts every aspect of software success. As AI continues to reshape the technology landscape, the importance of accurate, up-to-date documentation becomes even more critical. Investing in documentation today means building a stronger foundation for tomorrow's success. +Getting Started +I've been through the documentation improvement journey multiple times, and here's what I've learned works best: +1. Start with an honest audit of your current docs +2. Focus on your users' biggest pain points first +3. Build a sustainable documentation culture +4. Use tools like Akiradocs to automate and improve +5. Keep measuring and iterating +Remember, great documentation isn't about perfection - it's about continuous improvement. Start where you are, use the tools available, and keep making it better. Your future self (and your users) will thank you. ------------- [Document: articles/ai_integration.json] Title: AI Assistant Integration @@ -251,6 +358,55 @@ Context-aware translations Technical term preservation Format maintenance ------------- +[Document: docs/guides/analytics.json] +Title: Analytics Integration +Learn how to add analytics tracking to your documentation +AkiraDocs supports Google Analytics 4 (GA4) out of the box. This guide will help you set up analytics tracking for your documentation. +Setting up Google Analytics +1. Create a Google Analytics 4 property in your [Google Analytics account](https://analytics.google.com/) +2. Get your Measurement ID (starts with "G-") +3. Add the ID to your `akiradocs.config.json`: +Code example: +{ +"analytics": { +"google": { +"measurementId": "G-XXXXXXXXXX", +"enabled": true +}, +"debug": false +} +} +What's Tracked Automatically +Page views +Navigation between pages +Time on page +User language preferences +Device and browser information +Custom Event Tracking +You can track custom events using the `useAnalytics` hook: +Code example: +import { useAnalytics } from '@/hooks/useAnalytics' +function MyComponent() { + const { track } = useAnalytics() + const handleClick = () => { + track('doc_rating', { + rating: 5, + page: 'getting-started', + helpful: true + }) + } + return +} +Debug Mode +Enable debug mode to see analytics events in the console during development: +Code example: +{ +"analytics": { +"debug": true +} +} +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. @@ -474,55 +630,6 @@ Code example: }, } ------------- -[Document: docs/guides/analytics.json] -Title: Analytics Integration -Learn how to add analytics tracking to your documentation -AkiraDocs supports Google Analytics 4 (GA4) out of the box. This guide will help you set up analytics tracking for your documentation. -Setting up Google Analytics -1. Create a Google Analytics 4 property in your [Google Analytics account](https://analytics.google.com/) -2. Get your Measurement ID (starts with "G-") -3. Add the ID to your `akiradocs.config.json`: -Code example: -{ -"analytics": { -"google": { -"measurementId": "G-XXXXXXXXXX", -"enabled": true -}, -"debug": false -} -} -What's Tracked Automatically -Page views -Navigation between pages -Time on page -User language preferences -Device and browser information -Custom Event Tracking -You can track custom events using the `useAnalytics` hook: -Code example: -import { useAnalytics } from '@/hooks/useAnalytics' -function MyComponent() { - const { track } = useAnalytics() - const handleClick = () => { - track('doc_rating', { - rating: 5, - page: 'getting-started', - helpful: true - }) - } - return -} -Debug Mode -Enable debug mode to see analytics events in the console during development: -Code example: -{ -"analytics": { -"debug": true -} -} -This provides a complete analytics integration that's easy for users to set up and extend as needed. -------------- [Document: docs/getting-started/requirements.json] Title: System Requirements Before installing AkiraDocs, ensure your environment meets the following requirements. @@ -675,6 +782,23 @@ Tables (Coming Soon) Dividers Custom components (Coming Soon) ------------- +[Document: docs/editor/getting-started.json] +Title: Getting Started with the Editor +Learn how to start using the AkiraDocs editor effectively +Quick Start +Getting started with the AkiraDocs editor is straightforward. This guide will walk you through the basic setup and initial usage. +Basic Operations +Click the '+' button to add a new block +Drag blocks to reorder them +Use the toolbar for text formatting +Keyboard Shortcuts +Creating Your First Document +1. Click 'New File' in the sidebar +2. Add a title and description +3. Start adding blocks using the '+' button or '/' command +4. Use drag and drop to organize your content +5. Save your work using the save button +------------- [Document: docs/editor/features.json] Title: Editor Features Detailed overview of AkiraDocs editor capabilities and features. @@ -724,6 +848,56 @@ Git integration Change history Rollback capabilities ------------- +[Document: docs/editor/blocks.json] +Title: Block Types +Comprehensive guide to all available block types in the editor +Text Blocks +Paragraph: Basic text content with rich formatting +Heading: Six levels of headers (H1-H6) +List: Ordered and unordered lists +Quote: Blockquotes for citations +Code: Syntax-highlighted code blocks +Media Blocks +Image: Support for images with captions +Video: Embedded video player +Audio: Audio player with controls +File: File attachments and downloads +Interactive Blocks +Button: Clickable buttons with custom actions +Checklist: Interactive task lists +Table: Structured data presentation +------------- +[Document: docs/editor/ai-features.json] +Title: AI Features +Explore the AI-powered capabilities of the AkiraDocs editor +AI Providers +OpenAI: GPT-4 and GPT-3.5 integration +Anthropic: Claude integration +Custom Models: Support for self-hosted models +API Configuration: Flexible provider setup +Content Enhancement +Automatic grammar and style correction +Content summarization +Text expansion and elaboration +Tone adjustment and rewriting +Translation Support +Built-in AI translation capabilities support content localization across multiple languages while maintaining context and technical accuracy. +Configuration +Code example: +// AI Feature Configuration +{ + "aiProviders": { + "openai": { + "apiKey": "your-api-key", + "model": "gpt-4" + }, + "anthropic": { + "apiKey": "your-api-key", + "model": "claude-2" + } + } +} +------------- [Document: docs/contributing/how-to-contribute.json] Title: Contributing to AkiraDocs Guide to contributing to the AkiraDocs open-source project. diff --git a/docs/src/components/layout/Navigation.tsx b/docs/src/components/layout/Navigation.tsx index 66d293d..4e9a500 100644 --- a/docs/src/components/layout/Navigation.tsx +++ b/docs/src/components/layout/Navigation.tsx @@ -13,7 +13,7 @@ import { ErrorBoundary } from 'react-error-boundary' import { getApiNavigation } from '@/lib/content'; import { useAnalytics } from '@/hooks/useAnalytics'; const buttonStyles = { - base: "w-full justify-start text-left font-normal rounded-lg transition-all px-3 py-2", + base: "w-full justify-start text-left font-normal rounded-lg transition-all px-3 py-2 whitespace-normal", hover: "hover:bg-accent/40 hover:text-accent-foreground", active: "bg-gradient-to-r from-accent to-accent/80 text-accent-foreground font-medium shadow-md translate-x-1", state: "data-[state=open]:bg-accent/30", @@ -118,14 +118,14 @@ const NavItem = React.memo(({ locale, item, pathname, depth = 0 }: NavItemProps) ) : ""} {item.path ? ( - + {item.title} ) : ( - {item.title} + {item.title} )} {item.badge && ( - + {item.badge} )} diff --git a/packages/akiradocs/src/components/layout/Navigation.tsx b/packages/akiradocs/src/components/layout/Navigation.tsx index 66d293d..4e9a500 100644 --- a/packages/akiradocs/src/components/layout/Navigation.tsx +++ b/packages/akiradocs/src/components/layout/Navigation.tsx @@ -13,7 +13,7 @@ import { ErrorBoundary } from 'react-error-boundary' import { getApiNavigation } from '@/lib/content'; import { useAnalytics } from '@/hooks/useAnalytics'; const buttonStyles = { - base: "w-full justify-start text-left font-normal rounded-lg transition-all px-3 py-2", + base: "w-full justify-start text-left font-normal rounded-lg transition-all px-3 py-2 whitespace-normal", hover: "hover:bg-accent/40 hover:text-accent-foreground", active: "bg-gradient-to-r from-accent to-accent/80 text-accent-foreground font-medium shadow-md translate-x-1", state: "data-[state=open]:bg-accent/30", @@ -118,14 +118,14 @@ const NavItem = React.memo(({ locale, item, pathname, depth = 0 }: NavItemProps) ) : ""} {item.path ? ( - + {item.title} ) : ( - {item.title} + {item.title} )} {item.badge && ( - + {item.badge} )} diff --git a/packages/create-app/package.json b/packages/create-app/package.json index 7bc576a..e83bf55 100644 --- a/packages/create-app/package.json +++ b/packages/create-app/package.json @@ -1,6 +1,6 @@ { "name": "create-akiradocs", - "version": "1.0.50", + "version": "1.0.51", "description": "Create Akira Docs documentation sites with one command", "main": "./dist/index.js", "type": "module",