232 update akiradocs documentation

[shreyashkgupta]

Comprehensive Enhancements to AkiraDocs Editor Documentation

• Purpose:
  This pull request consolidates multiple improvements to the AkiraDocs editor documentation, enhancing usability and clarity.
• Key Changes:
  • Introduced a "Getting Started" section for user guidance on editor functionalities.
  • Expanded documentation on "Block Types" and "Key Features" to cover modern, block-based design and capabilities.
  • Added sections for AI-powered features, including content enhancement and translation support.
  • Reorganized content for clarity, simplifying descriptions and removing redundancies.
  • Provided a high-level overview of the editor's modular design and technology stack.
  • Updated template files with improved formatting and replaced placeholder images for consistency.
  • Enhanced user interaction by replacing toggle lists with checklists and buttons.
  • Improved list and heading structures for better organization and readability.
  • Added new UI components like spacers and buttons to enhance the interface.
• Impact:
  These changes significantly enhance the clarity, usability, and aesthetic of the AkiraDocs editor documentation, making it more accessible and informative for users.

✨ Generated with love by Kaizen ❤️

Original Description

Updated documentation for editor in all 4 languages. Also updated the template.json files

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
akira-docs	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Dec 20, 2024 2:41pm

[kaizen-bot]

🔍 Code Review Summary

❗ Attention Required: This push has potential issues. 🚨

Overview

• Total Feedbacks: 2 (Critical: 2, Refinements: 0)
• Files Affected: 2
• Code Quality: [█████████████████░░░] 85% (Good)

🚨 Critical Issues

Performance (2 issues)

1. Optimize image file sizes to improve page load times

---

📁 File: docs/compiled/en/docs/editor/blocks.json
🔍 Reasoning:
Large image file sizes can significantly impact page load times, especially for users on slow internet connections. Optimizing image sizes can improve the overall performance of the documentation.

💡 Solution:
Implement an image optimization process to reduce the file sizes of all images used in the documentation. Consider using techniques like compression, resizing, and format conversion to minimize the file sizes without compromising image quality.

Current Code:

"<strong>Image</strong>: Support for images with captions"

Suggested Code:

        "<strong>Image</strong>: Support for optimized images with captions"

2. Ensure the documentation does not contain any sensitive information

---

📁 File: docs/compiled/es/docs/editor/ai-features.json
🔍 Reasoning:
The documentation should not contain any sensitive or confidential information that could pose a security risk if accessed by unauthorized individuals.

💡 Solution:
Review the content of the documentation to ensure it does not include any sensitive information, such as API keys, credentials, or other private data. If such information is present, remove it or replace it with placeholder values.

Current Code:

"// Configuración de características de IA
{
  "aiProviders":{
    "openai":{
      "apiKey": "su-clave-api",
      "model": "gpt-4"
},
    "anthropic":{
      "apiKey": "su-clave-api",
      "model": "claude-2"
}
}
}"

Suggested Code:

      "// AI Features Configuration
      {
        "aiProviders":{
          "openai":{
            "apiKey": "YOUR_API_KEY",
            "model": "gpt-4"
      },
          "anthropic":{
            "apiKey": "YOUR_API_KEY",
            "model": "claude-2"
      }
      }
      }"

---

Test Cases

2 file need updates to their tests. Run !unittest to generate create and update tests.

---

✨ Generated with love by Kaizen ❤️

Useful Commands

• Feedback: Share feedback on kaizens performance with !feedback [your message]
• Ask PR: Reply with !ask-pr [your question]
• Review: Reply with !review
• Update Tests: Reply with !unittest to create a PR with test changes

[kaizen-bot]

Consider implementing the following changes to improve the code.

[kaizen-bot]

Comment: Optimize image file sizes to improve page load times

Solution: Implement an image optimization process to reduce the file sizes of all images used in the documentation. Consider using techniques like compression, resizing, and format conversion to minimize the file sizes without compromising image quality.
!! Make sure the following suggestion is correct before committing it !!

Suggested change

	"<strong>Image</strong>: Support for images with captions",
	"<strong>Image</strong>: Support for optimized images with captions"

[kaizen-bot]

Comment: Ensure the documentation does not contain any sensitive information

Solution: Review the content of the documentation to ensure it does not include any sensitive information, such as API keys, credentials, or other private data. If such information is present, remove it or replace it with placeholder values.
!! Make sure the following suggestion is correct before committing it !!

Suggested change

	"type": "code",
	"content": "// Configuración de características de IA\n{\n \"aiProviders\": {\n \"openai\": {\n \"apiKey\": \"su-clave-api\",\n \"model\": \"gpt-4\"\n },\n \"anthropic\": {\n \"apiKey\": \"su-clave-api\",\n \"model\": \"claude-2\"\n }\n }\n}",
	"metadata": {
	"language": "javascript",
	"showLineNumbers": true
	}
	}
	"// AI Features Configuration
	{
	"aiProviders":{
	"openai":{
	"apiKey": "YOUR_API_KEY",
	"model": "gpt-4"
	},
	"anthropic":{
	"apiKey": "YOUR_API_KEY",
	"model": "claude-2"
	}
	}
	}"