From 5307eb296aba56c6170f17c7a8133aac283b73c5 Mon Sep 17 00:00:00 2001 From: Saurav Panda Date: Fri, 8 Nov 2024 17:55:05 -0800 Subject: [PATCH] Readme Changes --- README.md | 252 ++++++++++++++++++++++++++++-------------------------- 1 file changed, 133 insertions(+), 119 deletions(-) diff --git a/README.md b/README.md index f184350..ee3dccb 100644 --- a/README.md +++ b/README.md @@ -1,161 +1,175 @@ -# AkiraDocs Template +# AkiraDocs +> Transform your documentation workflow in minutes, not months -
- -🚀 A modern, AI-powered documentation platform frontend with dynamic UI and in-app editing capabilities. +[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) +[![License: Commercial](https://img.shields.io/badge/License-Commercial-blue.svg)](https://example.com/commercial) +[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](https://makeapullrequest.com) -[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](LICENSE) -[![Next.js](https://img.shields.io/badge/Built%20with-Next.js-black)](https://nextjs.org) -[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](CONTRIBUTING.md) +## 😟 Common Documentation Challenges -
+- **Developer Teams**: "We want to keep using Markdown and Git..." +- **Content Teams**: "We need a user-friendly editor..." +- **Technical Writers**: "Managing multiple doc versions is a nightmare..." +- **Product Managers**: "Our docs are always out of sync..." +- **Enterprise Leaders**: "We need better documentation analytics..." -## ✨ Features +## 🎯 The AkiraDocs Solution -### Core Features -- 📝 **In-App Content Editor**: Edit documentation directly in the browser with real-time preview -- 🎨 **Dynamic UI Components**: Interactive components that bring your documentation to life -- 🔄 **Drag-and-Drop Interface**: Intuitive content organization using dnd-kit -- 🎯 **Live Preview**: See changes instantly as you edit -- 📱 **Responsive Design**: Perfect viewing experience across all devices -- 🔗 **Backend Integration**: Seamless integration with AkiraDocs Backend for advanced features [Coming Soon] +One platform that brings everyone's workflow together: -### Coming Soon -- 🔄 **Version Control**: Built-in documentation versioning -- 👥 **Multi-User Collaboration**: Real-time collaborative editing -- 🎨 **Theme Studio**: Visual theme customization interface -- 🔌 **Plugin System**: Extend functionality with custom plugins +✓ Developers keep their Markdown/Git workflow +✓ Content teams get their block-based WYSIWYG editor +✓ Everyone stays in sync, automatically +✓ SEO-optimized documentation by default +✓ Multi-language support with AI-powered translations -## 🚀 Quick Start +## 🎭 Perfect For Every Use Case -### Prerequisites -- Node.js ≥ 18 -- npm or yarn -- AkiraDocs Backend (for full functionality) +### Developer Documentation +- API References +- SDK Guides +- Technical Specifications +- Implementation Examples +- Architecture Docs -### Installation +### Product Documentation +- User Guides +- Feature Documentation +- Release Notes +- Tutorials +- FAQs +- Interactive Components +- Embedded Media Blocks -```bash -# Clone the template repository -git clone https://github.com/yourusername/akiradocs.git +### Enterprise Knowledge +- Internal Wikis +- Process Documentation +- Training Materials +- Compliance Docs +- Best Practices -# Navigate to project -cd akiradocs +## 🚀 Migrate Existing Docs in Minutes (Coming Soon) -# Install dependencies -npm install +Bring your existing documentation from anywhere: -# Configure environment variables -cp .env.example .env.local -# Edit .env.local with your backend API URL - -# Start development server -npm run dev +```bash +# Migrate your docs with a single command +npx akiradocs-migrate import --from=source --to=mydocs + +# Sources we support: +✓ Markdown/MDX files +✓ GitBook +✓ Docusaurus +✓ ReadTheDocs +✓ Confluence +✓ Notion ``` -Visit `http://localhost:3000` to see your documentation site. +### Migration Features +- 🔄 Automatic content structuring +- 🖼️ Image and asset handling +- 🔗 URL redirects setup +- 📱 Responsive optimization +- 🔍 SEO meta generation -## 📖 Project Structure +## 🎯 SEO-Optimized by Default -``` -akiradocs/ -├── _contents/ # Example documentation -├── src/ -│ ├── app/ # Next.js app directory -│ ├── components/ # React components -│ │ ├── content/ # Content-related components -│ │ └── ui/ # UI components -│ ├── lib/ # Frontend utilities -│ ├── types/ # Frontend type definitions -│ └── config/ # Frontend configuration -├── public/ -└── package.json -``` - -## 🛠️ Tech Stack +Every page is automatically optimized for search engines: -- **Framework**: Next.js -- **Styling**: Tailwind CSS -- **Content**: MDX -- **DnD**: dnd-kit for drag-and-drop functionality -- **Backend Integration**: REST API with TypeScript interfaces +- 📊 SEO-friendly URL structures +- 🏷️ Auto-generated meta tags +- 📱 Mobile-first indexing ready +- 🔍 Structured data markup +- 🚀 Blazing-fast performance +- 🗺️ Automatic sitemap generation +- 📈 Built-in SEO analytics -## 🔗 Backend Integration [Optional] +## ✍️ Modern Block-Based Editor -This is a standalone template like nextradocs but if you want to enable more features you can use our backend repo. -This template is designed to work with [AkiraDocs Backend](https://github.com/Cloud-Code-AI/akiradocs-backend) for full functionality. The integration includes: +Write documentation the modern way: -- Smart content recommendations -- Automated content summarization -- Question-answering capabilities -- Document similarity analysis -- Pre-configured API interfaces -- Type-safe API communication -- Analytics integration -- Search functionality +- 📝 Rich Text Blocks +- 🖼️ Image & Media Blocks +- 📊 Diagrams & Charts +- 💻 Code Blocks with Syntax Highlighting +- 📑 Collapsible Sections +- 📋 Tables & Lists +- 🔲 Custom Component Blocks +- 🔄 Reusable Content Blocks -### Environment Variables [OPTIONAL] +## 🌐 Powerful Language Support -Required environment variables for backend integration: +Reach a global audience effortlessly: -``` -NEXT_PUBLIC_API_URL=http://localhost:8000 # Your backend API URL -``` +- 🔄 AI-powered translation suggestions +- 📝 Side-by-side translation editor +- 🔍 Translation memory & glossaries +- 🌍 100+ languages supported +- 📊 Translation progress tracking +- 🔄 Automatic content sync across languages +- 📱 Right-to-left (RTL) support +- 🎯 Language-specific SEO optimization -## 🤝 Contributing +## 🔮 Coming Soon -We love our contributors! Check out our [Contributing Guide](CONTRIBUTING.md) to get started. +We're constantly improving. Here's what's next: -### Development Process -1. Fork the repository -2. Create your feature branch (`git checkout -b feature/amazing-feature`) -3. Commit your changes (`git commit -m 'Add amazing feature'`) -4. Push to the branch (`git push origin feature/amazing-feature`) -5. Open a Pull Request +### Q4 2024 +- 🤖 AI-powered content suggestions +- 🔄 Advanced version control +- 🌐 Enhanced translation workflows +- 📊 Enhanced analytics dashboard +- 🔄 Translation automation tools -## 📜 License +### Q1 2025 +- 👥 Real-time collaboration +- 🎨 Visual theme editor +- 🔌 Plugin marketplace +- 🤝 Third-party integrations -AkiraDocs is [MIT licensed](LICENSE). +## 🚀 Get Started -## 💖 Support +```bash +npx create-akiradocs mydocs +``` -If you find AkiraDocs helpful, please consider: -- Starring the repository -- Sharing it with others -- Contributing to the project +## 💪 Why Choose AkiraDocs? -## 🔗 Links +- **For Developers** + - Keep your existing Git workflow + - Full Markdown/MDX support + - Custom component development + - API-first architecture -- [Website](https://akiradocs.ai) -- [Documentation](https://docs.akiradocs.ai) -- [Backend Repository](https://github.com/Cloud-Code-AI/akiradocs-backend) -- [Discord Community](https://discord.gg/6qfmtSUMdb) +- **For Content Teams** + - Modern WYSIWYG editor + - Real-time previews + - No coding required + - Version control made easy -## Content Migration +- **For Enterprise** + - SSO/SAML integration + - Audit logs + - Custom deployment options + - Priority support -### Migrating Existing Content +## 📄 Licensing -You can easily migrate content from existing blogs or documentation sites using our built-in scraper utility. The scraper will: -- Download and process your content -- Extract structured data including title, description, and content blocks -- Download and organize associated images -- Generate a `_meta.json` file for navigation -- Save content in the proper format for this platform +- **MIT License**: Free for open source and personal projects except for enterprise features (see below) +- **Commercial License**: Enterprise features and support -#### Usage +## 🤝 Join Our Community -Run the scraper using `tsx`: - -```bash -tsx src/utils/scraper.ts [options] - -Options: - -l, --urls Array of specific URLs to scrape - -t, --type Content type (e.g., 'articles', 'docs') -``` +- [Discord Community](https://discord.gg/akiradocs) +- [GitHub Discussions](https://github.com/akiradocs/discussions) +- [Documentation](https://docs.akiradocs.com) +- [Enterprise Support (Coming Q1 2025)](https://akiradocs.com/enterprise) --- -
-Made with ❤️ by the Cloud Code AI Team + +**[Get Started](https://docs.akiradocs.com/quickstart)** • +**[Live Demo](https://demo.akiradocs.com)** • +**[Enterprise Trial](https://akiradocs.com/enterprise)** (Coming Q1 2025) +
\ No newline at end of file