Merge pull request #225 from Cloud-Code-AI/210-thinking-of-splitting-…

…api-reference-into-separate-module-and-would-be-installed-based-on-create-app-input

feat: moved api reference to different folder and separate installation

docs/_contents/en/articles/importance_of_documentation.md

@@ -0,0 +1,154 @@
+---
+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-10
+modifiedDate: 2024-11-10
+category: "Technical Insights"
+keywords:
+  - Documentation
+  - Developer Experience
+  - Customer Success
+  - AI Training
+  - Open Source
+  - SaaS
+---
+
+# The Critical Importance of Documentation in Modern Software Development
+
+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.

docs/_contents/en/articles/welcome.md

@@ -1,26 +1,46 @@
 ---
-title: Welcome to Akira Doc
-description: Get started with Akira Docs - Next-gen documentation powered by AI
-author: Anonymous
+title: "Welcome to Cloud Code AI: Building the Future of AI-Powered Documentation"
+description: "Join us on our journey to revolutionizing customer experience with advanced AI documentation tools."
+author: "Cloud Code AI Team"
 publishDate: 2024-11-10
 modifiedDate: 2024-11-10
-category: Getting Started
+category: "Company Blog"
 keywords:
-  - Akira Docs
-  - Documentation
-  - AI
+  - Cloud Code AI
+  - AI Documentation
+  - Customer Experience
+  - AI DevOps
 ---
 
-# Welcome to Akira Doc
+# Welcome to Cloud Code 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.
+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).
 
-## Key Features
+## Our Evolution
 
-- Easy to customize
-- AI-powered search
-- Block-based content system
-- Responsive design
+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).
 
-> [!info] Getting Started
-> Start by customizing this template to match your project's needs!
+## 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.

docs/akiradocs.config.json

@@ -27,7 +27,7 @@
               { "label": "navigation.menu.aiSearch", "href": "/aiSearch", "icon": "/sparkles.svg", "show": true },
               { "label": "navigation.menu.docs", "href": "/en/docs", "icon": "/legacy.svg", "show": true },
               { "label": "navigation.menu.articles", "href": "/en/articles", "icon": "/articles.svg", "show": true },
-              { "label": "navigation.menu.apiReference", "href": "/apiReference", "icon": "/api.svg", "show": true }
+              { "label": "navigation.menu.apiReference", "href": "/apiReference", "icon": "/api.svg", "show": false }
           ]
       }
   },

docs/compiled/de/articles/_meta.json

@@ -4,10 +4,6 @@
     "title": "Willkommen bei Akira Doc",
     "path": "/articles/welcome"
   },
-  "template": {
-    "title": "Testblogbeitrag",
-    "path": "/articles/template"
-  },
   "ai_integration": {
     "title": "Ai Integration",
     "path": "/articles/ai_integration"