Merge pull request #2238 from sthaha/reorg-docs

docs: reorganize documentation into user and developer sections

Author: Sunil Thaha

Makefile

@@ -139,8 +139,7 @@ coverage: test ## Coverage report generation (HTML)
 # Generate metrics documentation
 .PHONY: gen-metrics-docs
 gen-metrics-docs: ## Documentation generation for metrics
-	$(GOCMD) run ./hack/gen-metric-docs/main.go --output metrics.md
-	mv metrics.md docs/metrics/
+	$(GOCMD) run ./hack/gen-metric-docs/main.go --output docs/user/metrics.md
 
 # Run linting
 .PHONY: lint

README.md

@@ -73,9 +73,16 @@ helm install kepler manifests/helm/kepler/ --namespace kepler --create-namespace
 
 ## 📖 Documentation
 
+### User Documentation
+
 - **[Installation Guide](docs/user/installation.md)** - Detailed installation instructions for all deployment methods
-- **[Configuration Guide](docs/configuration/configuration.md)** - Configuration options and examples
-- **[Metrics Documentation](docs/metrics/metrics.md)** - Available metrics and their descriptions
+- **[Configuration Guide](docs/user/configuration.md)** - Configuration options and examples
+- **[Metrics Documentation](docs/user/metrics.md)** - Available metrics and their descriptions
+
+### Developer Documentation
+
+- **[Power Attribution Guide](docs/developer/power-attribution-guide.md)** - How Kepler measures and attributes power consumption
+- **[Developer Documentation](docs/developer/)** - Contributing guidelines and development workflow
 
 For more detailed documentation, please visit the [official Kepler documentation](https://sustainable-computing.io/kepler/).
 

docs/design/assets/release.png renamed to docs/developer/assets/release.png

@@ -10,6 +10,10 @@ This section contains documentation for developers working on Kepler.
 
 - [Pre-commit Setup](pre-commit.md) - Setting up pre-commit hooks for code quality
 
+## Release Management
+
+- [Release Process](release.md) - Kepler release process and lifecycle
+
 ## Contributing
 
 For general contribution guidelines, please refer to the main project documentation.

docs/design/assets/release.uml renamed to docs/developer/assets/release.uml

@@ -6,24 +6,19 @@ Welcome to the Kepler documentation. Kepler is a Prometheus exporter that measur
 
 ### [User Documentation](user/)
 
+Documentation for users deploying and operating Kepler:
+
 - [Installation Guide](user/installation.md) - How to install and deploy Kepler
+- [Configuration Guide](user/configuration.md) - Configuring Kepler for your environment
+- [Metrics Reference](user/metrics.md) - Available Prometheus metrics exported by Kepler
 
 ### [Developer Documentation](developer/)
 
+Documentation for developers contributing to Kepler:
+
 - [Power Attribution Guide](developer/power-attribution-guide.md) - How Kepler measures and attributes power consumption
 - [Pre-commit Setup](developer/pre-commit.md) - Development workflow setup
-
-### [Configuration](configuration/)
-
-- [Configuration Guide](configuration/configuration.md) - Configuring Kepler for your environment
-
-### [Design Documents](design/)
-
-- [Release Process](design/release.md) - Kepler release process and lifecycle
-
-### [Metrics](metrics/)
-
-- [Metrics Documentation](metrics/metrics.md) - Available Prometheus metrics exported by Kepler
+- [Release Process](developer/release.md) - Kepler release process and lifecycle
 
 ## Quick Start