Navigation

# Documentation Navigation & Sitemap

Home / Knowledge Base / Navigation

---

Complete navigation structure for Neuron ERP documentation.

Documentation Hierarchy

Neuron ERP Documentation
|
|--  Home (index.md)
|   |-- Overview
|   |-- Quick Links
|   |-- Module Documentation Links
|   |-- System Architecture
|   |-- Technology Stack
|
|--  Getting Started (getting-started.md)
|   |-- Prerequisites
|   |-- Logging In
|   |-- Interface Overview
|   |-- Basic Workflows
|   |-- Common Tasks
|   |-- Troubleshooting
|
|-- |-- Architecture (architecture.md)
|   |-- System Overview
|   |-- Architecture Layers
|   |-- Technology Stack
|   |-- Project Structure
|   |-- Data Flow
|   |-- Security Architecture
|   |-- Integration Points
|
|--  ADR - Architecture Decision Records (adr/)
|   |-- ADR Index (adr/index.md)
|   |-- Database User Ownership Consolidation (adr/0001-database-user-ownership-consolidation.md)
|
|--  Installation (installation.md)
|   |-- System Requirements
|   |-- Pre-installation Checklist
|   |-- Installation Steps
|   |-- Database Setup
|   |-- Application Configuration
|   |-- Post-Installation Tasks
|
|--  Modules (modules/)
|   |-- Module Overview (modules/index.md)
|-- Financial Management
|-- Distribution & Inventory
|-- Manufacturing
|-- Sales & Delivery
|-- Human Resources
|   |-- Financial (modules/financial/)
|-- Accounts Receivable (accounts-receivable.md)
|-- Accounts Payable (accounts-payable.md)
|-- General Ledger (general-ledger.md)
|-- Cash Management (cash-management.md)
|-- Fixed Assets (fixed-assets.md)
|-- Budgeting (budget.md)
|-- Multiple Currency (multiple-currency.md)
|-- Tax Invoice (tax-invoice.md)
|   |-- Distribution (modules/distribution/)
|-- Purchase Orders (purchase-order.md)
|-- Purchase Requisitions (requisition.md)
|-- Inventory Management (inventory.md)
|-- Quality Inspection (inspection.md)
|-- Bill of Quantities (boq.md)
|   |-- Manufacturing (modules/manufacturing/)
|-- Work Orders (work-order.md)
|-- Product Structure (product-structure.md)
|-- Routing & Work Centers (routing.md)
|-- Shopfloor Control (shopfloor.md)
|   |-- Sales (modules/sales/)
|-- Sales Orders (sales-order.md)
|-- Delivery Management (delivery.md)
|-- Price Lists (pricelist.md)
|-- Target Achievement (target-achievement.md)
|   |-- HR (modules/hr/)
|   |-- Employee Information (employee-information.md)
|   |-- Payroll (payroll.md)
|   |-- Time & Attendance (time-attendance.md)
|   |-- Training Management (training.md)
|
|--  Technical (technical/)
    |-- Development Guide (development-guide.md)
    |-- API Reference (api-reference.md)
    |-- Database Schema / ERD (erd.md)
    |-- Configuration Guide (configuration-guide.md)
    |-- Contributing Guidelines (contributing.md)

|-- Developer Quick Start (developers/)
    |-- Getting Started (developers/getting-started.md)
    +-- Developer Resources (developers/index.md)

|-- Troubleshooting (troubleshooting/)
    |-- Troubleshooting Guide (troubleshooting/index.md)
    +-- Menu Auto-Click Fix (troubleshooting/menu-auto-click-fix.md)

User Journey Maps

For End Users

graph LR
    A[Start] --> B[index.md]
    B --> C[getting-started.md]
    C --> D[modules/index.md]
    D --> E[Select Module]
    E --> F[Module Documentation]
    F --> G[Daily Use]

Recommended Path:

1. Read Main Index
2. Follow Getting Started Guide
3. Review Module Overview
4. Study specific module docs (e.g., Sales Orders)
5. Reference as needed during daily use

For Administrators

graph LR
    A[Start] --> B[installation.md]
    B --> C[architecture.md]
    C --> D[Module Setup]
    D --> E[User Training]
    E --> F[Ongoing Support]

Recommended Path:

1. Review Architecture Overview
2. Follow Installation Guide
3. Configure modules per Module Docs
4. Train users with Getting Started
5. Maintain system using technical docs

For Developers

graph LR
    A[Start] --> B[architecture.md]
    B --> C[developers/getting-started.md]
    C --> D[development-guide.md]
    D --> E[Code]
    E --> F[Test]
    F --> G[Deploy]

Recommended Path:

1. Understand System Architecture
2. Quick setup with Developer Getting Started
3. Read Full Development Guide
4. Follow coding standards
5. Build, test, and deploy
6. Build and test
7. Deploy using guidelines

Documentation By Topic

Security & Access

• Getting Started - Login
• Architecture - Security
• Development - Security

Financial Management

• General Ledger Module
• Accounts Receivable
• Accounts Payable
• Cash Management

Inventory & Distribution

• Inventory Management
• Purchase Orders
• Purchase Requisitions

Sales & Orders

• Sales Order Module
• Delivery Management
• Price Lists

Manufacturing

• Work Orders
• Product Structure
• Routing

Human Resources

• Employee Information
• Payroll
• Time & Attendance

Configuration & Setup

• Installation Guide
• Architecture Overview
• Module Configuration

|-- Development & Technical

• Developer Quick Start
• Development Guide
• System Architecture
• API Reference

Quick Reference Guide

Common Tasks

Task	Documentation
First Time Login	Getting Started
Create Sales Order	Sales Orders
Post Journal Entry	General Ledger
Generate Reports	Getting Started
Install System	Installation Guide
Develop New Feature	Development Guide
Review Architecture Decisions	Architecture Decision Records

Troubleshooting

Issue	Reference
Login Problems	Getting Started - Troubleshooting
Installation Issues	Installation - Troubleshooting
Module Errors	Specific module documentation
Development Issues	Development Guide
Menu Auto-Click Issue	Menu Auto-Click Fix

Documentation Statistics

Content Summary

• Total Documentation Files: 10+ Markdown files
• Mermaid Diagrams: 50+ embedded diagrams
• Code Examples: 20+ code snippets
• Modules Documented: 20+ modules (overview/samples)
• Word Count: ~25,000+ words

Coverage

pie title Documentation Coverage
    "Getting Started" : 15
    "Architecture" : 20
    "Module Docs" : 35
    "Technical Docs" : 20
    "Installation" : 10

Documentation Templates

Module Documentation Template

Each module doc should include:

1. Overview
2. Key Features
3. Module Structure (diagram)
4. Process Workflows (Mermaid)
5. User Procedures
6. Reports & Analytics
7. Best Practices
8. Troubleshooting
9. Integration Points
10. Related Documentation

See examples:

• General Ledger
• Sales Orders

Cross-Reference Matrix

From	To	Relationship
Getting Started	Modules	User learns about features
Modules	General Ledger	Financial integration
Sales Orders	Inventory	Stock allocation
Installation	Architecture	System understanding
Development Guide	Architecture	Technical foundation

Documentation Roadmap

Completed (Current Release)

• Main index and overview
• Getting started guide
• Architecture documentation
• Installation guide
• Module overview
• Sample module docs (GL, SO)
• Development guide
• Navigation structure
• Architecture Decision Records (ADR)

Future Enhancements

• Complete all module documentation
• API reference documentation
• Database schema diagrams
• Video tutorials (links)
• FAQ section
• Troubleshooting guide
• Best practices guide
• Performance tuning guide
• Security hardening guide
• Backup & recovery procedures

Documentation Best Practices

For Readers

1. Start with index.md
2. Follow the recommended path for your role
3. Use search (Ctrl+F) to find specific topics
4. Check related documentation links
5. Bookmark frequently used pages

For Contributors

1. Follow the established structure
2. Use Mermaid for diagrams
3. Keep language clear and concise
4. Include code examples
5. Add cross-references
6. Update Last Updated dates
7. Test all procedures

Feedback & Updates

How to Provide Feedback

1. Document specific page/section
2. Describe issue or suggestion
3. Provide context if applicable
4. Submit to documentation team

Documentation Updates

• Version controlled in Git
• Review process for changes
• Regular quarterly reviews
• User feedback incorporated

---

Documentation Structure Created: January 2026
Total Files: 10+ comprehensive guides
Format: Markdown with embedded Mermaid diagrams
Portability: 100% offline-capable, no external dependencies

Start Here: Main Documentation Index