Skip to content

docs: fix remaining broken documentation links#1126

Open
wangwangbobo wants to merge 4 commits intomlco2:masterfrom
wangwangbobo:fix-broken-doc-links
Open

docs: fix remaining broken documentation links#1126
wangwangbobo wants to merge 4 commits intomlco2:masterfrom
wangwangbobo:fix-broken-doc-links

Conversation

@wangwangbobo
Copy link

Fixes #1125

This PR completes the fix for broken documentation links by replacing the remaining mlco2.github.io/codecarbon URLs with docs.codecarbon.io in:

  • webapp/src/app/(dashboard)/home/page.tsx (2 links)
  • codecarbon/core/powermetrics.py (1 link)
  • codecarbon/cli/main.py (1 link)
  • codecarbon/external/ram.py (1 link)
  • examples/notebooks/codecarbon_workshop.ipynb (1 link)

Total: 6 link fixes across 5 files.

Related to previous work in commit e5d6f8e which fixed links in README.md, CONTRIBUTING.md, and copilot-instructions.md.

Closes mlco2#1125

Replaced all mlco2.github.io/codecarbon links with docs.codecarbon.io:
- README.md (6 links)
- CONTRIBUTING.md (2 links)
- .github/copilot-instructions.md (2 links)
- Replace mlco2.github.io/codecarbon with docs.codecarbon.io in:
  - webapp/src/app/(dashboard)/home/page.tsx (2 links)
  - codecarbon/core/powermetrics.py (1 link)
  - codecarbon/cli/main.py (1 link)
  - codecarbon/external/ram.py (1 link)
  - examples/notebooks/codecarbon_workshop.ipynb (1 link)

Fixes: mlco2#1125
@wangwangbobo wangwangbobo requested a review from a team as a code owner March 22, 2026 10:41
Copy link
Member

@SaboniAmine SaboniAmine left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for your contribution!
A small comment on a maybe incorrect occurence but otherwise it's good, thanks.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The URL doesn't seem correct in this file, is it a rendering problem ?

- Update mkdocs.yml edit_uri to use main branch
- Update CONTRIBUTING.md rebase instructions
- Update emissions_tracker.py docstring URLs
- Add process_tree tracking mode to CPU module for consistency with RAM

Fixes mlco2#1084 and addresses mlco2#976
- Add 'process_tree' as an alias for 'process' tracking mode
- Provides consistent naming with RAM module
- Tracks main process and all children recursively
- Addresses mlco2#976 (Inconsistent behaviour for RAM and CPU Monitoring)

The process_tree mode uses the same implementation as process mode,
which already includes child processes via psutil.children(recursive=True).
This alias improves API clarity and consistency.
Copy link
Member

@SaboniAmine SaboniAmine left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The process tree feature is interesting, but could you please add it in a separate PR ? it might deserve a dedicated discussion, cc @benoit-cty

@codecov
Copy link

codecov bot commented Mar 22, 2026

Codecov Report

❌ Patch coverage is 3.03030% with 32 lines in your changes missing coverage. Please review.
✅ Project coverage is 80.09%. Comparing base (46ac6dd) to head (ba37652).

Files with missing lines Patch % Lines
codecarbon/external/hardware.py 3.03% 32 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##           master    #1126      +/-   ##
==========================================
- Coverage   80.74%   80.09%   -0.66%     
==========================================
  Files          41       41              
  Lines        3921     3953      +32     
==========================================
  Hits         3166     3166              
- Misses        755      787      +32     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Broken link to documentation

2 participants