Skip to content

docs: Documentation Improvement and Restructuring #7

@bitsalv

Description

@bitsalv

📝 Description

Complete review and improvement of the entire Edge Mining documentation: restructure organization, integrate content from core repository, update for current features, and improve quality.

🎯 Scope

Structure & Organization

  • Redesign information architecture for better user flow
  • Separate user guides, technical docs, and reference materials
  • Create logical navigation from beginner to advanced

Content Integration

  • Migrate technical docs from edge-mining/core/docs/entities
  • Integrate frontend/API documentation
  • Update content to reflect current functionality across all repositories

Quality Improvements

  • Standardize Markdown formatting according to VuePress guidelines
  • Add practical code examples and diagrams using VuePress features
  • Improve writing clarity and technical accuracy
  • Implement VuePress-specific features (TOC, code highlighting, Vue components)

Proposed Structure

docs/
├── intro.md                          # Updated project overview
├── getting-started/                  # NEW: Comprehensive getting started
│   ├── installation.md
│   ├── quick-start.md
│   └── first-setup.md
├── user-guide/                       # NEW: User-focused documentation
│   ├── configuration.md
│   ├── energy-integration.md
│   ├── monitoring.md
│   └── troubleshooting.md
├── technical/                        # NEW: Technical documentation
│   ├── architecture/                 # Updated from existing modelling/
│   │   ├── overview.md
│   │   ├── domain-driven-design.md
│   │   └── system-components.md
│   ├── entities/                     # Migrated from core/docs/entities/
│   ├── api/                          # NEW: API documentation
│   └── development/                  # NEW: Development guides
├── integrations/                     # NEW: Integration guides
│   ├── home-assistant.md
│   ├── energy-systems.md
│   └── third-party.md
├── about/                            # Reorganized from about-us.md
│   ├── project.md
│   ├── team.md
│   └── roadmap.md
├── community/                        # NEW: Community resources
│   ├── contributing.md               # Moved from contribution.md
│   ├── support.md
│   └── faq.md                        # Moved from faq.md
└── reference/                        # NEW: Reference materials
    ├── glossary.md                   # Moved from modelling/
    ├── configuration-reference.md
    └── api-reference.md

📋 Acceptance Criteria

  • Comprehensive coverage of all Edge Mining aspects
  • Clear navigation serving both users and developers
  • Content reflects current system functionality
  • Professional, consistent formatting throughout
  • No scattered documentation across repositories

🔗 Related

📊 Priority

High - Critical for project adoption and developer onboarding

Metadata

Metadata

Labels

documentationImprovements or additions to documentationenhancementNew feature or request

Type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions