Merge pull request #149 from Cloud-Code-AI/148-fix-bold-elements-in-l…

…ist-items feat: added docs and its updates!
Cloud-Code-AI · Nov 30, 2024 · 7e5e36c · 7e5e36c
2 parents 6967d1b + 3d84bd9
commit 7e5e36c
Show file tree

Hide file tree

Showing 130 changed files with 9,467 additions and 2,692 deletions.
diff --git a/README.md b/README.md
@@ -3,6 +3,12 @@
   <h1 align="center">AkiraDocs</h1>
 </p>
 
+<p align="center">
+  <a href="https://discord.gg/zvYZukgeH2">
+    <img src="https://img.shields.io/badge/Join_Our_Discord-7289DA?style=for-the-badge&logo=discord&logoColor=white" alt="Join Our Discord">
+  </a>
+</p>
+
 <p align="center">
   <h4 align="center"><strong>Beautiful docs that write, translate, and optimize themselves</strong></h4>
 </p>
@@ -40,15 +46,32 @@ Or via CLI:
 npx create-akiradocs <optional folder name>
 ```
 
+![AkiraDocs installation](gifs/install_akiradocs.gif)
+
 ## 🎯 Perfect For
 - **Developers**: API docs, SDK guides, implementation examples
 - **Product Teams**: User guides, release notes, tutorials
 - **Enterprises**: Internal wikis, process documentation, knowledge bases
 
 ## ✨ Key Features
 
+### Notion-like Editor
+Intuitive block-based interface with real-time preview
+
+![AkiraDocs editor](gifs/akiradocs_editor.gif)
+
+### AI-Powered Content Generation
+Automatically enhance your content with AI
+
+![AkiraDocs AI](gifs/ai_rewrites.gif)
+
+### Translation
+Translate your content to multiple languages with AI
+
+![AkiraDocs Translation](gifs/translate.gif)
+
 ### 🔍 AI-Generated SEO Optimization
-- Automatically optimize your documentation for search engines with AI-driven SEO
+Automatically optimize your documentation for search engines with AI-driven SEO
 - Improve discoverability and reach without manual SEO adjustments
 - AI recommendations for keywords and metadata
 
@@ -64,11 +87,6 @@ npx create-akiradocs <optional folder name>
 - Rich media support
 - Reusable content blocks
 
-### 🏢 Enterprise-Ready
-- SSO/SAML integration
-- Audit logs
-- Custom deployment options
-- Version control
 
 ## 🌍 Going Global
 Built-in AI-powered translation. Just add API keys:

diff --git a/docs/README.md b/docs/README.md
@@ -100,7 +100,7 @@ npx akiradocs-migrate import --from=source --to=mydocs
 - [Live Demo](https://demo.akiradocs.ai)
 - [Documentation](https://docs.akiradocs.com)
 - [Discord Community](https://discord.gg/zvYZukgeH2)
-- [GitHub Discussions](https://github.com/akiradocs/discussions)
+- [GitHub Discussions](https://github.com/Cloud-Code-AI/akiradocs/discussions)
 - [Join Waitlist](https://forms.gle/KunU4BGhToH4NJ1t7) for early access
 
 ## 📄 Licensing

diff --git a/docs/_contents/en/docs/contributing/how-to-contribute.md b/docs/_contents/en/docs/contributing/how-to-contribute.md
@@ -18,7 +18,7 @@ Guide to contributing to the AkiraDocs open-source project.
 ### Setup Development Environment
 ```bash
 # Clone repository
-git clone https://github.com/akiradocs/akiradocs
+git clone https://github.com/Cloud-Code-AI/akiradocs
 cd akiradocs
 
 # Install dependencies

diff --git a/docs/_contents/en/docs/getting-started/features.md b/docs/_contents/en/docs/getting-started/features.md
@@ -52,15 +52,3 @@ A comprehensive overview of AkiraDocs' core features and capabilities.
 ✓ Docusaurus
 ✓ ReadTheDocs
 ```
-
-## Feature Comparison
-
-| Feature | AkiraDocs | Traditional Docs |
-|---------|-----------|------------------|
-| Notion-like Editor | ✓ | ✗ |
-| AI Translation | ✓ | ✗ |
-| AI Search | ✓ | ✗ |
-| Auto SEO | ✓ | Partial |
-| Markdown Support | ✓ | ✓ |
-| Build Optimization | ✓ | Varies |
-
diff --git a/docs/_contents/en/docs/getting-started/requirements.md b/docs/_contents/en/docs/getting-started/requirements.md
@@ -20,12 +20,11 @@ Before installing AkiraDocs, ensure your environment meets the following require
 - Recommended: Latest LTS version
 
 ### System Memory
-- Minimum: 4GB RAM
-- Recommended: 8GB RAM or more
+- Minimum: 2GB RAM
+- Recommended: 4GB RAM or more
 
 ### Storage
-- Minimum: 1GB free space
-- Recommended: 5GB+ for larger documentation projects
+- Recommended: 1GB free space
 
 ## Software Dependencies
 
@@ -46,34 +45,6 @@ Before installing AkiraDocs, ensure your environment meets the following require
 - Linux (Ubuntu 20.04 or later recommended)
 
 ### IDE/Editor Support
-- VS Code (recommended)
-- WebStorm
+- VS Code (coming soon)
+- WebStorm (coming soon)
 - Any text editor with Markdown support
-
-## Network Requirements
-
-### Cloud Features
-- Stable internet connection
-- Access to npm registry
-- Access to GitHub (for version control)
-
-### Enterprise Features
-- Outbound HTTPS (443) access
-- WebSocket support
-- Custom domain (optional)
-
-## Browser Support
-
-### Desktop Browsers
-- Chrome (last 2 versions)
-- Firefox (last 2 versions)
-- Safari (last 2 versions)
-- Edge (last 2 versions)
-
-### Mobile Browsers
-- iOS Safari
-- Android Chrome
-
-## Verification
-
-Run the following command to check if your environment is ready:
diff --git a/docs/_contents/en/docs/installation/configuration.md b/docs/_contents/en/docs/installation/configuration.md
@@ -20,6 +20,7 @@ Edit `akiradocs.config.json`:
 
 ```json
 {
+    "url": "https://docs.akiradocs.com",
     "site": {
         "title": "Your Docs",
         "description": "Your documentation description"

diff --git a/docs/_contents/en/docs/installation/setup.md b/docs/_contents/en/docs/installation/setup.md
@@ -21,38 +21,30 @@ Ensure your system meets the [requirements](../getting-started/requirements.md)
 
 ### 1. Local Development Setup
 
-1. **Clone the Repository**
+1. **Create New Project**
 ```bash
-git clone https://github.com/your-org/akira-docs-template
-cd akira-docs-template
+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:
 ```bash
 npm install
 ```
 
 3. **Create Environment File**
-```bash
-cp .env.example .env.local
-```
+The environment file is created automatically. You can modify it at `.env.local`
 
-4. **Configure Environment Variables**
-```env
-NEXT_PUBLIC_API_URL=your_api_url
-NEXT_PUBLIC_SITE_URL=your_site_url
-```
-
-### 2. Docker Installation
-
-1. **Pull the Docker Image**
+4. **Start Development Server** 
 ```bash
-docker pull akiradocs/akiradocs:latest
+npm run dev
 ```
 
-2. **Run the Container**
+5. **Update AkiraDocs**
+To update an existing installation to the latest version:
 ```bash
-docker run -p 3000:3000 akiradocs/akiradocs:latest
+npx create-akiradocs@latest update
 ```
 
 ### 3. Cloud Platform Deployment
@@ -64,10 +56,10 @@ docker run -p 3000:3000 akiradocs/akiradocs:latest
 4. Deploy
 
 #### Other Platforms
-- AWS Amplify
-- Netlify
-- Digital Ocean
-- Custom server
+- AWS Amplify (Coming Soon)
+- Netlify (Coming Soon)
+- Digital Ocean (Coming Soon)
+- Custom server (Coming Soon)
 
 ## Post-Installation Steps
 
@@ -106,7 +98,3 @@ DEBUG=false
 NODE_ENV=test
 TEST_MODE=true
 ```
-
-## Next Steps
-- [Configuration Guide](./configuration.md)
-- [Troubleshooting](./troubleshooting.md)
diff --git a/docs/_contents/en/docs/seo-and-performance/robot-txt.md b/docs/_contents/en/docs/seo-and-performance/robot-txt.md
@@ -11,36 +11,17 @@ keywords:
 
 # Robots.txt Configuration
 
-Guide to customizing and managing your robots.txt file in AkiraDocs.
+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
 ```txt
 User-agent: *
 Allow: /
-Sitemap: https://yourdocs.com/sitemap.xml
+Sitemap: https://docs.akiradocs.com/sitemap.xml
 
 # Private sections
 Disallow: /admin/
 Disallow: /private/
 ```
-
-## Customization
-
-### Configuration Options
-```json
-{
-  "seo": {
-    "robots": {
-      "enabled": true,
-      "autoGenerate": true,
-      "custom": {
-        "disallow": ["/internal/", "/draft/"],
-        "allow": ["/public/"],
-        "crawlDelay": 10
-      }
-    }
-  }
-}
-```
diff --git a/docs/_contents/en/docs/seo-and-performance/sitemap-generation.md b/docs/_contents/en/docs/seo-and-performance/sitemap-generation.md
@@ -17,20 +17,6 @@ Learn how AkiraDocs automatically generates and manages your documentation sitem
 
 AkiraDocs automatically generates a sitemap.xml file during the build process, ensuring search engines can efficiently crawl your documentation.
 
-### Default Configuration
-```json
-{
-  "seo": {
-    "sitemap": {
-      "enabled": true,
-      "autoGenerate": true,
-      "changefreq": "weekly",
-      "priority": 0.7
-    }
-  }
-}
-```
-
 ## Generated Sitemap Structure
 
 ### Example Output
@@ -51,36 +37,3 @@ AkiraDocs automatically generates a sitemap.xml file during the build process, e
   </url>
 </urlset>
 ```
-
-## Customization Options
-
-### Priority Settings
-```json
-{
-  "seo": {
-    "sitemap": {
-      "priorities": {
-        "home": 1.0,
-        "docs": 0.8,
-        "blog": 0.6,
-        "other": 0.5
-      }
-    }
-  }
-}
-```
-
-### Update Frequency
-```json
-{
-  "seo": {
-    "sitemap": {
-      "changefreq": {
-        "home": "daily",
-        "docs": "weekly",
-        "blog": "monthly"
-      }
-    }
-  }
-}
-```
diff --git a/docs/akiradocs.config.json b/docs/akiradocs.config.json
@@ -1,4 +1,5 @@
 {
+  "url": "https://docs.akiradocs.com",
   "site": {
       "title": "Akira Docs",
       "description": "Next-gen documentation powered by AI"
@@ -73,9 +74,12 @@
   },
   "analytics": {
       "google": {
-          "measurementId": "",
-          "enabled": false
+          "measurementId": "G-GPZ4Z4QP6F",
+          "enabled": true
       },
       "debug": false
+  },
+  "features": {
+    "textToSpeech": false
   }
-}
+}