NeuAIs Internal Documentation

Internal documentation for developers and operations

This documentation is for the NeuAIs development team and covers internal architecture, integration details, and operational procedures.

🎯 For New Team Members

Start here:

1. Quick Start Guide - Set up your development environment
2. Development Tools - IDE, Git, and automation tools
3. Control Panel Guide - Using the management interface

📖 Documentation Sections

Getting Started

Essential guides for setting up and running the platform locally.

• Quick Start - 3-step setup guide
• Development Tools - IDE and Git server setup
• Control Panel - Dashboard usage

Observatory

Deep dives into the 3D visualization system.

• Visual Customization - Colors, shapes, themes
• Agent Connection - How agents connect to Observatory

Integration

Technical integration guides for various systems.

• SMO/RIC Integration - O-RAN architecture
• Model Inventory - ML model management
• GitArena/Lapdev - Tool rebranding

Management

Team operations and management documentation.

• Team Operations Plan - How we work together

Architecture

Deep technical architecture documentation.

• O-RAN SMO/RIC - O-RAN architecture documents and diagrams

🔧 Quick Links

Development:

• Main README - Project overview
• Observatory README - Observatory docs
• External Docs - Public documentation
• Prebuilds Cache - Nix prebuilts DB (cache.db, populate/query usage)

Configuration:

• Dev Config - Development configuration
• Prod Config - Production configuration
• Staging Config - Staging configuration

Management:

• Compliance - Compliance documentation
• Dev Team - Development team docs
• Operations - Operational runbooks

🌐 External Resources

Public Documentation:

• https://docs.neuais.com - Public-facing documentation
• https://observatory.neuais.com - Observatory application
• https://github.com/neuais/platform - GitHub repository

📝 Documentation Standards

Writing Style

• Clear and concise
• Code examples for everything
• Step-by-step instructions
• Troubleshooting sections

Formatting

• Markdown format
• GitBook-compatible structure
• Code blocks with language tags
• Tables for structured data

Updates

• Keep docs synchronized with code
• Update on every major change
• Version documentation
• Archive outdated docs

🤝 Contributing to Docs

Adding New Documentation

1. Create markdown file in appropriate directory
2. Add to SUMMARY.md
3. Follow existing structure
4. Include code examples
5. Add troubleshooting section

Updating Existing Docs

1. Make changes in place
2. Update “Last updated” date
3. Test all code examples
4. Verify links work

Doc Structure

# Title

Brief introduction (1-2 paragraphs)

## Section 1

Content with code examples

## Section 2

More content

---

Last updated: YYYY-MM-DD

📊 Documentation Status

🐛 Found an Issue?

Documentation bugs:

1. Check if already reported
2. Create issue with details
3. Suggest correction
4. Submit PR if you can fix it

Code bugs:

• Use GitHub Issues
• Include reproduction steps
• Attach logs/screenshots

Last updated: December 12, 2025