ORGANIZATION STATS - nself-org/cli GitHub Wiki

Documentation Organization Statistics

Date: January 30, 2026

Directory Count by Category

Directory Files Description
getting-started/ 4 Entry point for new users
guides/ 35+ How-to guides and workflows
tutorials/ 9 Step-by-step tutorials
commands/ 93 CLI command reference
configuration/ 7 Configuration reference
architecture/ 14 System architecture
services/ 10 Services documentation
deployment/ 4 Deployment guides
plugins/ 6 Plugin system
reference/ 4 + api/ Reference materials
reference/api/ 4 API documentation
examples/ 9 Code examples
features/ 4 Feature documentation
releases/ 50+ Version history
migrations/ 6 Migration guides
security/ 16 Security documentation
troubleshooting/ 2 Troubleshooting
contributing/ 7 Contributor docs
qa/ 8 QA reports
Root level 3 Index files

Total Statistics

  • Total Directories: 21
  • Total Markdown Files: 280+
  • Root-level Files: 3 (README.md, Home.md, _Sidebar.md)
  • Documentation Files: 4 (STRUCTURE.md, REORGANIZATION-SUMMARY.md, this file)

Directory Purpose Summary

User-Facing Documentation (Main Categories)

  1. getting-started/ (4 files)

    • NEW directory for onboarding
    • Installation, Quick Start, FAQ
    • First stop for new users
  2. guides/ (35+ files)

    • EXPANDED with billing, white-label, database content
    • Comprehensive how-to documentation
    • Covers all major features
  3. tutorials/ (9 files)

    • Step-by-step tutorials
    • Use-case specific (SaaS, B2B, Marketplace, Agency)
    • Feature tutorials (OAuth, Stripe, File Uploads)
  4. reference/ (8+ files)

    • CONSOLIDATED quick references
    • API documentation (moved from api/)
    • Cheat sheets and quick lookups

Technical Documentation

  1. commands/ (93 files)

    • EXPANDED with CLI docs
    • Individual command documentation
    • Command trees and maps
  2. architecture/ (14 files)

    • System design
    • Build architecture
    • Command reorganization docs
  3. configuration/ (7 files)

    • Environment variables
    • Service configuration
    • Start command options
  4. services/ (10 files)

    • Required/Optional/Custom services
    • Monitoring bundle
    • Service templates

Specialized Documentation

  1. deployment/ (4+ files)

    • Production deployment
    • Cloud providers
    • Deployment examples
  2. security/ (16 files)

    • Security audits
    • SQL safety
    • Validation guides
  3. migrations/ (6 files)

    • CONSOLIDATED migration content
    • Platform migrations (Firebase, Nhost, Supabase)
    • Internal migrations
  4. releases/ (50+ files)

    • Version release notes
    • Roadmap
    • Phase completion reports

Support & Contribution

  1. troubleshooting/ (2 files)

    • Feature-specific troubleshooting
    • Common issues
  2. contributing/ (7 files)

    • EXPANDED with development docs
    • Contributing guide
    • Cross-platform compatibility
    • CLI output standards
  3. qa/ (8 files)

    • QA reports
    • Validation results
    • Issue tracking

Additional Categories

  1. examples/ (9 files)

    • Real-world examples
    • Code patterns
    • Configuration examples
  2. features/ (4 files)

    • Feature-specific documentation
    • Realtime, White-label, File uploads
  3. plugins/ (6 files)

    • Plugin system
    • Plugin development
    • Available plugins

Improvements Made

Organization

  • Reduced directory count from 28 → 21
  • Removed 9 scattered directories
  • Created 2 focused directories
  • Consolidated 45+ files

Discoverability

  • Clear entry point (getting-started/)
  • Logical groupings by purpose
  • Better separation of concerns
  • Reduced navigation depth

Maintainability

  • Related content together
  • Less duplication
  • Clearer directory purposes
  • Easier to find documentation

File Distribution

Top 5 Largest Directories:
1. commands/      93 files  (CLI reference)
2. releases/      50+ files (version history)
3. guides/        35+ files (expanded with billing, white-label, etc.)
4. security/      16 files  (security documentation)
5. architecture/  14 files  (system architecture)

Next Steps

  1. Update internal links in existing documentation
  2. Update _Sidebar.md to reflect new structure
  3. Update Home.md with new navigation
  4. Verify no broken links remain
  5. Consider adding README.md to directories without them

Generated: January 30, 2026 Documentation Version: v0.9.6

⚠️ **GitHub.com Fallback** ⚠️