Skip to content

Commit 7e342f4

Browse files
feat: improve Discord community references throughout docs and README
Add Discord community links to key documentation and README sections to make it easier for users to get help, contribute, and connect with the community: - README: Add Discord badge and community callout box - Navigation menu: Add "Join Our Discord" link - Documentation landing page: Add Discord to quick links table - FAQ: Add Discord references for help and bug reporting - Code of Conduct: Update reporting mechanism to include Discord - Contributing guide: Add Discord to question section and add community help section - First tracking tutorial: Add "Need help?" section with Discord link - Visualization guide: Add Discord to next steps for sharing results Moved Discord reference from Cloud API guide (overly technical) to Visualization guide (team/community-oriented) for better fit. This makes Discord visible at multiple entry points: README → landing page → tutorials → guides → FAQ → community pages.
1 parent f4f5387 commit 7e342f4

9 files changed

Lines changed: 23 additions & 4 deletions

File tree

README.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,16 @@
44

55
Estimate and track carbon emissions from your computer, quantify and analyze their impact.
66

7-
[![](https://img.shields.io/pypi/v/codecarbon?color=024758)](https://pypi.org/project/codecarbon/) [![DOI](https://zenodo.org/badge/263364731.svg)](https://zenodo.org/badge/latestdoi/263364731) [![OpenSSF Scorecard](https://api.scorecard.dev/projects/github.com/mlco2/codecarbon/badge)](https://scorecard.dev/viewer/?uri=github.com/mlco2/codecarbon) [![codecov](https://codecov.io/gh/mlco2/codecarbon/graph/badge.svg)](https://codecov.io/gh/mlco2/codecarbon)
7+
[![](https://img.shields.io/pypi/v/codecarbon?color=024758)](https://pypi.org/project/codecarbon/) [![DOI](https://zenodo.org/badge/263364731.svg)](https://zenodo.org/badge/latestdoi/263364731) [![OpenSSF Scorecard](https://api.scorecard.dev/projects/github.com/mlco2/codecarbon/badge)](https://scorecard.dev/viewer/?uri=github.com/mlco2/codecarbon) [![codecov](https://codecov.io/gh/mlco2/codecarbon/graph/badge.svg)](https://codecov.io/gh/mlco2/codecarbon) [![Discord](https://img.shields.io/badge/Discord-Join%20Community-7289da?logo=discord&logoColor=white)](https://discord.gg/GS9js2XkJR)
88

99
- **A lightweight, easy to use Python library** – Simple API to track emissions
1010
- **Open source, free & community driven** – Built by and for the community
1111
- **Effective visual outputs** – Put emissions in context with real-world equivalents
1212

1313
> **Tracking GenAI API calls?** CodeCarbon measures emissions from **local computing** (your hardware). To track emissions from remote GenAI API calls (OpenAI, Anthropic, Mistral, etc.), use [**EcoLogits**](https://ecologits.ai/). Both tools are complementary.
1414
15+
> **Join the community!** Have questions, want to share your work, or contribute? Join us on [**Discord**](https://discord.gg/GS9js2XkJR) – we're here to help and excited to hear from you!
16+
1517
## Installation
1618

1719
```bash
@@ -97,6 +99,7 @@ You can visualize your experiment emissions on the [dashboard](https://dashboard
9799
| [Framework examples (scikit-learn)](https://docs.codecarbon.io/latest/how-to/scikit-learn/) | Task-oriented ML framework examples |
98100
| [Methodology](https://docs.codecarbon.io/latest/explanation/methodology/) | How emissions are calculated |
99101
| [EcoLogits](https://ecologits.ai/) | Track emissions from GenAI API calls |
102+
| [Discord Community](https://discord.gg/GS9js2XkJR) | Chat with us and the community |
100103

101104
## Links
102105

docs/explanation/faq.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ Yes. CodeCarbon can be installed and used in Docker containers just like any oth
3939

4040
## How can I help?
4141

42-
If you find any functionality missing in the CodeCarbon repo, please [open an issue](https://github.com/mlco2/codecarbon/issues) so that you (and others!) can help add it. We did our best to cover all use cases and options, but we count on the open source community to help make the package an even greater success.
42+
If you find any functionality missing in the CodeCarbon repo, please [open an issue](https://github.com/mlco2/codecarbon/issues) so that you (and others!) can help add it. We did our best to cover all use cases and options, but we count on the open source community to help make the package an even greater success. You can also discuss ideas on [Discord](https://discord.gg/GS9js2XkJR) before diving into development.
4343

4444
## Is my data sent anywhere?
4545

@@ -55,3 +55,5 @@ Please open an issue on [GitHub](https://github.com/mlco2/codecarbon/issues) wit
5555
- Your environment details
5656
- Steps to reproduce
5757
- Expected vs actual behavior
58+
59+
You can also report bugs and ask for help on [Discord](https://discord.gg/GS9js2XkJR) where we can provide quick guidance.

docs/how-to/cloud-api.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -62,3 +62,4 @@ save_to_api = true
6262
## View Your Results
6363

6464
Once your runs complete, visit the [CodeCarbon dashboard](https://dashboard.codecarbon.io/) to see your results. For more visualization options, see the [visualization guide](visualize.md).
65+

docs/how-to/code-of-conduct.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ We agree to restrict the following behaviors in our community. Instances, threat
4747

4848
Tensions can occur between community members even when they are trying their best to collaborate. Not every conflict represents a code of conduct violation, and this Code of Conduct reinforces encouraged behaviors and norms that can help avoid conflicts and minimize harm.
4949

50-
When an incident does occur, it is important to report it promptly. To report a possible violation, **[NOTE: describe your means of reporting here.]**
50+
When an incident does occur, it is important to report it promptly. To report a possible violation, please contact us via [GitHub Issues](https://github.com/mlco2/codecarbon/issues) or [Discord](https://discord.gg/GS9js2XkJR).
5151

5252
Community Moderators take reports of violations seriously and will make every effort to respond in a timely manner. They will investigate all reports of code of conduct violations, reviewing messages, logs, and recordings, or interviewing witnesses and other participants. Community Moderators will keep investigation and enforcement actions as transparent as possible while prioritizing safety and confidentiality. In order to honor these values, enforcement actions are carried out in private with the involved parties, but communicating to the whole community may be part of a mutually agreed upon resolution.
5353

docs/how-to/contributing.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@
3939
<!-- TOC --><a name="have-a-question"></a>
4040
## </a> Have a Question?
4141

42-
Please see the [FAQ](https://docs.codecarbon.io/latest/explanation/faq/) for questions.
42+
Please see the [FAQ](https://docs.codecarbon.io/latest/explanation/faq/) for questions. You can also ask on our [Discord community](https://discord.gg/GS9js2XkJR) – we're happy to help!
4343

4444

4545
<!-- TOC --><a name="found-a-bug"></a>
@@ -547,6 +547,10 @@ PORT="8000"
547547
```
548548

549549

550+
## Questions or Need Help?
551+
552+
Got stuck? Have an idea? Want to share your contribution? **[Join us on Discord](https://discord.gg/GS9js2XkJR)** – our community is here to help and support you!
553+
550554
<!-- TOC --><a name="license"></a>
551555
## License
552556

docs/how-to/visualize.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -104,3 +104,4 @@ The app also provides a visualization of regional carbon intensity of electricit
104104
- [Set up the Cloud API](cloud-api.md) to send data to the online dashboard
105105
- [Configure CodeCarbon](configuration.md) for additional tracking options
106106
- [Integrate with experiment tracking tools](comet.md) like Comet for seamless workflow integration
107+
- [Join our Discord](https://discord.gg/GS9js2XkJR) to share your results and discuss emissions tracking with the community

docs/index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -77,3 +77,4 @@ A single datacenter can consume large amounts of energy to run computing code. A
7777
| [Framework Examples](how-to/scikit-learn.md) | Example usage patterns |
7878
| [Methodology](explanation/methodology.md) | How emissions are calculated |
7979
| [EcoLogits](https://ecologits.ai/latest/?utm_source=codecarbon&utm_medium=docs) | Track emissions from GenAI API calls |
80+
| [Discord Community](https://discord.gg/GS9js2XkJR) | Chat with us and the community |

docs/tutorials/first-tracking.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -62,3 +62,7 @@ print(f"Energy consumed: {tracker.final_emissions_data.energy_consumed:.6f} kWh"
6262
- Explore all [Python API options](python-api.md) (decorators, explicit objects, offline mode)
6363
- See the full [API Reference](../reference/api.md) for all configuration parameters
6464
- Try the [CodeCarbon Workshop notebook](https://github.com/mlco2/codecarbon/blob/master/examples/notebooks/codecarbon_workshop.ipynb) for a comprehensive hands-on experience
65+
66+
## Need help?
67+
68+
Have questions about tracking, want to share your results, or contribute to CodeCarbon? **[Join our Discord community](https://discord.gg/GS9js2XkJR)** – we're here to help!

mkdocs.yml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ copyright: "&copy; CodeCarbon"
1010

1111
theme:
1212
name: zensical
13+
custom_dir: overrides
1314
favicon: images/favicon.ico
1415
logo: images/codecarbon-logo.svg
1516
palette:
@@ -95,6 +96,7 @@ extra_css:
9596
extra_javascript:
9697
- javascripts/mathjax.js
9798
- https://unpkg.com/mathjax@3/es5/tex-mml-chtml.js
99+
- javascripts/discord-link.js
98100

99101
markdown_extensions:
100102
- abbr
@@ -182,3 +184,4 @@ nav:
182184
- Output Formats: reference/output.md
183185
- CLI Reference: reference/cli.md
184186
- Track GenAI API Calls (EcoLogits) ↗: https://ecologits.ai/latest/?utm_source=codecarbon&utm_medium=docs
187+
- Join Our Discord 💬 ↗: https://discord.gg/GS9js2XkJR

0 commit comments

Comments
 (0)