Skip to content

JoseCToscano/smart-docs

Repository files navigation

SmartDocs

SmartDocs Logo

A context-aware, AI-powered document editor that understands your content and provides intelligent assistance throughout your writing process.

Overview

SmartDocs is a sophisticated document editing platform that harnesses multiple state-of-the-art AI models to create an intuitive, context-aware writing environment. Similar to Cursor's intelligent coding experience, SmartDocs understands your document's context and provides real-time, relevant assistance for content creation, editing, and enhancement.

Features

🤖 AI-Powered Intelligence

  • Multi-Model AI Integration: Leverages multiple AI models for specialized tasks
  • Context-Aware Assistance: Understands document structure and content context
  • Intelligent Code Handling: Special support for technical documentation
  • Smart Formatting: AI-powered formatting suggestions based on content type
  • Semantic Search: Find relevant content across your documents instantly

📝 Advanced Editing

  • Rich Text Editing: Full-featured WYSIWYG editor with professional formatting
  • Real-time AI Suggestions: Contextual writing improvements as you type
  • Smart Templates: AI-generated document templates based on your needs
  • Version Control: Track changes with intelligent diff highlighting
  • Collaborative Features: Real-time collaboration with AI assistance

Technology Stack

SmartDocs is built using a modern technology stack:

  • UI Components: KendoReact (Enterprise-grade React UI)
  • AI Integration: Anthropic Claude via API
  • Framework: Next.js (React-based framework)
  • Styling: Tailwind CSS for utility-first styling
  • TypeScript: For type safety and developer experience

KendoReact Components

SmartDocs leverages KendoReact's rich component library to deliver a professional document editing experience:

Free Components

AppBar – Used as the main navigation Avatar – Displays the user profile in the header Button – Drives interactions across the UI Card – Showcases document previews Dialog – For File upload Modal Drawer – Hosts the sliding AI assistant panel DropDownList – Allows users to select and configure document's page and format Input – Used for titles and AI prompt fields Popup – Powers context menus like user's dropdown and page configuration Splitter – Enables resizable layout between the editor and AI panel Tooltip – Provides helpful context and in-app guidance

Premium Components

  • Editor: Rich text editing with comprehensive formatting tools

Architecture

SmartDocs follows a modular architecture:

  1. Document Editor: Core editing experience using KendoReact Editor
  2. AI Sidebar: Interface for interacting with Claude AI
  3. API Layer: Backend services for AI communication and document processing
  4. State Management: React state hooks for application state
  5. Component Library: Custom and KendoReact components

AI Integration

SmartDocs leverages multiple AI models for specialized tasks:

  • Content Generation: Advanced language models for high-quality writing
  • Code Understanding: Specialized models for technical content
  • Context Analysis: AI-powered document structure understanding
  • Smart Formatting: Intelligent layout and styling suggestions
  • Research Assistant: AI-powered fact-checking and reference gathering

How It Works

  1. Context Understanding: AI continuously analyzes your document's content and structure
  2. Intelligent Suggestions: Receives contextual recommendations for improvements
  3. Code-Aware: Special handling for code blocks and technical content
  4. Smart Formatting: Automatic formatting suggestions based on content type
  5. Version Management: AI-powered diff tracking and change management

Getting Started

Prerequisites

  • Node.js 16+
  • NPM or Yarn
  • Anthropic API key

Installation

  1. Clone the repository
git clone https://github.com/your-username/smart-docs.git
cd smart-docs
  1. Install dependencies
npm install
# or
yarn
  1. Set up environment variables
# Create a .env file with your Anthropic API key
ANTHROPIC_API_KEY=your_api_key_here
  1. Start the development server
npm run dev
# or
yarn dev
  1. Open http://localhost:3000 in your browser

Usage

  1. Creating a Document: Click "New Document" on the home page
  2. Editing Content: Use the rich text editor to write and format
  3. AI Assistance: Type prompts in the AI sidebar to get help
  4. Reviewing Changes: Accept or reject AI suggestions
  5. Saving Work: Click "Save" to store your document

Custom Components

SmartDocs extends KendoReact with custom components:

  • AISidebar: Specialized interface for AI interaction
  • DocumentToolbar: Context-aware editing tools
  • ProgressBar: Enhanced loading indicator for AI processes
  • AppBar: Navigation and document management header

Future Roadmap

  • Integration with additional specialized AI models
  • Enhanced context awareness capabilities
  • Advanced technical documentation features
  • Real-time collaboration improvements
  • Mobile-first experience
  • Offline capabilities with local AI processing

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Acknowledgements

  • KendoReact for the powerful UI components
  • Anthropic for Claude AI capabilities
  • Next.js team for the React framework
  • All open-source contributors

About

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published