Skip to content

README.md

Latest commit

 

History

History
94 lines (63 loc) · 2.51 KB

README.md

File metadata and controls

94 lines (63 loc) · 2.51 KB
Raw

Singularities AI Documentation

Official documentation for Singularities AI - an open source AI conversation platform.

📖 About

This documentation describes how to use Singularities AI, a platform for engaging in natural conversations with local AI models via Ollama.

🌐 Online Access

📚 Documentation Structure

The documentation is organized in two languages:

🇫🇷 French (/content/fr/)

  • Démarrer - Installation and setup guide
  • Fonctionnalités - Detailed feature descriptions

🇬🇧 English (/content/en/)

  • Getting Started - Installation and setup guide
  • Features - Detailed feature descriptions

🛠️ Technologies Used

  • Framework: Nuxt - Vue.js full-stack framework
  • UI Components: Shadcn/UI - Open source components
  • Content: Nuxt Content - Headless content system
  • Styling: Tailwind CSS - Utility-first CSS framework

🤝 Contributing

We welcome contributions to this documentation!

How to Contribute

  1. Fork the repository
  2. Create a branch for your feature (git checkout -b feature/amazing-feature)
  3. Commit your changes (git commit -m 'Add some amazing feature')
  4. Push to the branch (git push origin feature/amazing-feature)
  5. Open a Pull Request

Contribution Guidelines

  • Follow the existing file structure
  • Maintain consistency between French and English versions
  • Test locally before submitting
  • Use clear commit messages

📝 File Structure

content/
├── en/          # English documentation
│   ├── 1.getting-started/
│   └── 2.features/
└── fr/          # French documentation
    ├── 1.demarrer/
    └── 2.fonctionnalites/

🧪 Development

Available Commands

# Development
npm run dev

# Production build
npm run build

# Preview build
npm run preview

# Static generation
npm run generate

📞 Support

🔗 Useful Links

Singularities AI - Making conversational AI accessible to everyone 🚀