License License Language

Official documentation for NurOS Linux distribution.

• English (current file)
• Русский (Russian)
• Қазақша (Kazakh)

This repository contains comprehensive documentation for NurOS, an independent Linux distribution. The documentation covers all major components of the system:

• APG Package System - Advanced Package format and ecosystem
• Tulpar - Package manager and libapg library
• Tulpar Server - Package repository server
• AetherDE - Desktop environment
• System Utilities - Essential tools like switch
• Installation Guides - System installation and porting

• Node.js >= 18.0
• npm or yarn

# Clone the repository
git clone https://github.com/NurOS-Linux/docs.git
cd docs
# Install dependencies
npm install
# Start development server
npm start

The documentation site will open at http://localhost:3000.

# Build static site
npm run build
# Serve built site
npm run serve

docs/
├── docs/ # Documentation files
│ ├── apg/ # APG package system
│ ├── aether/ # AetherDE desktop environment
│ ├── utils/ # System utilities
│ └── installing/# Installation guides
├── blog/ # Blog posts
├── src/ # Custom components
└── static/ # Static assets

• Framework: Docusaurus 3.x
• Language: JavaScript, Markdown
• Deployment: GitHub Pages / Vercel

We welcome contributions! To contribute:

1. Fork the repository
2. Create a feature branch (git checkout -b feature/improvement)
3. Make your changes
4. Commit with descriptive messages (git commit -m 'Add: feature description')
5. Push to your fork (git push origin feature/improvement)
6. Open a Pull Request

• Use clear, concise language
• Follow the existing structure
• Test local build before submitting
• Include code examples where appropriate

• Documentation Content: Licensed under CC BY-SA 4.0
• Code Examples: Licensed under CC0
• NurOS Components: Various licenses (see individual projects)

• NurOS Website: https://nuros.org
• GitHub Organization: https://github.com/NurOS-Linux
• Issue Tracker: https://github.com/NurOS-Linux/docs/issues
• Discussions: https://github.com/NurOS-Linux/docs/discussions

• Discord: Join our server
• Telegram: @nuros_linux
• Matrix: #nuros:matrix.org

• Email: contact@nuros.org
• GitHub Issues: For documentation bugs and improvements

Copyright © 2025 NurOS Project