skip to content
Aurras

Documentation Structure Guide

3 min read

Navigate the Aurras documentation effectively with this guide to our organized series structure and content organization.

# aurras
# documentation
# navigation
# organization
Aurras Project Information

Aurras Documentation Organization

This guide helps you navigate the reorganized Aurras documentation structure designed for different user types and skill levels.

📚 Series Overview

🔰 User Documentation - Featured

For: New and existing users wanting to learn and use Aurras effectively
Goal: Complete learning path from installation to mastery

Content:

  1. Installation Guide - Setup on Linux, macOS, and Windows
  2. Quick Start Guide - Playing music in 2 minutes
  3. Basic Usage Guide - Interface, controls, and essential features
  4. Configuration Guide - Customization and settings
  5. Troubleshooting Guide - Common issues and solutions

Learning Path: Follow in order for optimal experience

⚡ Advanced Features

For: Power users and advanced enthusiasts
Goal: Master advanced features and professional workflows

Content:

  1. Advanced Features - Smart playlists, effects, automation
  2. Audio Processing Mastery - Professional audio workflows
  3. Advanced Playlist Management - Smart playlists and automation

Prerequisites: Complete User Documentation series first

👨‍💻 Developer Documentation

For: Developers, contributors, and technical users
Goal: Understanding architecture and contributing to the project

Content:

  1. Technical Deep Dive - Core architecture and design
  2. Contributing Guide - How to contribute code and features
  3. Architecture Overview - Detailed system architecture

Prerequisites: Programming knowledge helpful

📢 Project Information

For: All users interested in project updates and community
Goal: Stay informed about the project’s evolution

Content:

  1. Introducing Aurras - Project announcement and vision
  2. Changelog & Release Notes - Version history and updates
  3. Roadmap & Future Vision - Future plans and community priorities
  4. Documentation Structure Guide - This guide

🎯 Quick Access by Goal

I want to…

🚀 Get started quickly → Quick Start Guide

📖 Learn everything systematically
→ User Documentation Series

🔧 Fix a problem → Troubleshooting Guide

⚡ Unlock advanced features → Advanced Features Series

💻 Contribute to development → Developer Documentation Series

📊 See what’s new/coming → Project Information Series

🎨 Customize my setup → Configuration Guide

🎵 Master audio processing → Audio Processing Mastery

🔄 Content Migration Summary

What Changed

Before: Single “aurras-docs” series with 10+ mixed posts
After: 4 focused series organized by audience and purpose

Content Reorganization

Moved to User Docs:

  • Installation, Quick Start, Basic Usage, Configuration, Troubleshooting

Moved to Advanced:

  • Advanced Features, Audio Processing, Advanced Playlist Management

Moved to Developer Docs:

  • Technical Deep Dive, Contributing, Architecture Overview

Moved to Project Info:

  • Introduction, Changelog, Roadmap, Documentation Guide

New Content Added

Content Improvements

  • Troubleshooting Guide: Cleaned up duplicates, consolidated sections
  • Advanced Playlist Management: Moved from user docs to advanced series
  • Better cross-references: Updated links between related content

🧭 Navigation Tips

For New Users

  1. Start with Installation
  2. Follow the Quick Start
  3. Work through Basic Usage
  4. Customize with Configuration
  5. Keep Troubleshooting bookmarked

For Power Users

  1. Complete the User Documentation series first
  2. Explore Advanced Features
  3. Master Audio Processing
  4. Dive into Advanced Playlists

For Developers

  1. Read Technical Deep Dive
  2. Study Architecture Overview
  3. Follow Contributing Guide
  4. Join the development community

For Project Followers

  1. Check Changelog for updates
  2. Read Roadmap for future plans
  3. Join community discussions
  4. Provide feedback on upcoming features

📋 Content Guidelines

Series Consistency

  • Each series has a clear target audience
  • Posts within series build on previous knowledge
  • Cross-references guide users to related content

Quality Standards

  • Comprehensive but focused content
  • Real-world examples and use cases
  • Regular updates based on user feedback
  • Community-driven improvements

Maintenance Process

  • Regular content audits for relevance
  • User feedback incorporation
  • Version updates reflected in documentation
  • Community contributions welcomed

🤝 Contributing to Documentation

How to Help

For Users:

  • Report unclear or outdated content
  • Suggest missing topics or use cases
  • Share your workflows and tips
  • Provide feedback on organization

For Contributors:

  • Improve existing content
  • Add new guides and tutorials
  • Fix errors and inconsistencies
  • Help with translations

Getting Started

  1. Read the Contributing Guide
  2. Check GitHub Issues for documentation tasks
  3. Join Discord for discussions
  4. Submit pull requests with improvements

🔗 Related Resources

Community Resources

  • GitHub Discussions - Q&A and feature requests
  • Community Wiki - User-contributed content
  • Plugin Directory - Community extensions

Need help finding something? Join our Discord community or open an issue with your question!