docs: fix remaining broken documentation links#1126
docs: fix remaining broken documentation links#1126wangwangbobo wants to merge 4 commits intomlco2:masterfrom
Conversation
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
There was a problem hiding this comment.
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.
SaboniAmine
left a comment
SaboniAmine
left a comment
There was a problem hiding this comment.
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 Report❌ Patch coverage is
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. 🚀 New features to boost your workflow:
|
benoit-cty
left a comment
benoit-cty
left a comment
There was a problem hiding this comment.
Thanks for your contribution.
Be careful to check the new URL.
We have not just created a domain name but completely re factored the documentation.
| target="_blank" | ||
| > | ||
| https://mlco2.github.io/codecarbon/usage.html | ||
| https://docs.codecarbon.io/usage.html |
There was a problem hiding this comment.
https://docs.codecarbon.io/usage.html does not exist. Be careful to check the new URL.
We have not just created a domain name but completly refactor the documentation.
3 participants
Fixes #1125
This PR completes the fix for broken documentation links by replacing the remaining
mlco2.github.io/codecarbonURLs withdocs.codecarbon.ioin: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.