Home

Carbon Calculator Documentation

Welcome to the Carbon Calculator documentation. This guide helps you understand and work with the project.

Note: For general information about the project, features, and quick start instructions, please refer to the main README.md.

Documentation Pages

📊 Updating Content & Adding Data

Learn how to add new modules (emission categories) or support for new countries. This guide is designed for non-technical and limited technical users who want to update the calculator's data content.

🔧 Maintenance & Versioning

Understand how to keep the project updated with the latest dependencies, Node.js versions, and framework updates. This includes information about release cycles and what needs regular attention.

🏗️ Project Architecture

A technical deep-dive into how the Carbon Calculator is structured, including the data model, module system, and how emission factors are calculated.

🤝 Contributing Guidelines

Guidelines for developers who want to contribute to the project, including coding standards and submission process.

Quick Navigation

• Want to add a new country? → See Updating Content
• Want to add a new emission category? → See Updating Content
• Need to update dependencies? → See Maintenance
• Want to understand the codebase? → See Architecture
• Interested in contributing? → See Contributing Guidelines

Support

For issues, feature requests, or questions, please visit the GitHub repository.