SoK/2025/StatusReport/Roopa Dharshini: Difference between revisions
< SoK | 2025/StatusReport
No edit summary |
Week 1 Status is updates |
||
| Line 1: | Line 1: | ||
<h1> | <h1>Enhance KEcoLab Documentation and Create a Video Tutorial</h1> | ||
<h3>Project Abstract</h3> | |||
This project aims to improve the technical documentation for KEcoLab, a tool for measuring energy consumption in KDE applications. This includes enhancing existing documentation, creating new documentation on key aspects of the tool. | |||
<h3>Deliverables</h3> | |||
* Technical Documentation for the developers | |||
* Non-technical Documentation for the users | |||
<h3>Mentors</h3> | |||
* Joseph P. De Veaugh-Geiss @joseph:kde.org | |||
* Kieryn Darkwater (Video) @mxdarkwater:matrix.org | |||
* Karanjot Singh @drquark:kde.org | |||
* Aakarsh MJ @aakarshmj:matrix.org | |||
* Pradyot Ranjan (Video) @pradyotranjan:gitter.im | |||
<h3>Issues Working on</h3> | |||
* [https://invent.kde.org/teams/eco/remote-eco-lab/-/issues/29 Outline for the documentation] | |||
* [https://invent.kde.org/teams/eco/remote-eco-lab/-/issues/30 Usage Scenario Script for Users] | |||
* [https://invent.kde.org/teams/eco/remote-eco-lab/-/issues/32 CI/CD Documentation for Developers] | |||
<h3>Weekly Progress</h3> | |||
<h4>Week 1: </h4> | |||
* Explored KECoLab Project's codebase, and it's working through a demo. | |||
* Studied KECoLab's Handbook and existing documentation. | |||
* Set up a GitLab Wiki in the forked repository. | |||
* Discussed GitLab Wiki's Merge Request (MR) feature. | |||
Revision as of 15:43, 21 February 2025
Enhance KEcoLab Documentation and Create a Video Tutorial
Project Abstract
This project aims to improve the technical documentation for KEcoLab, a tool for measuring energy consumption in KDE applications. This includes enhancing existing documentation, creating new documentation on key aspects of the tool.
Deliverables
- Technical Documentation for the developers
- Non-technical Documentation for the users
Mentors
- Joseph P. De Veaugh-Geiss @joseph:kde.org
- Kieryn Darkwater (Video) @mxdarkwater:matrix.org
- Karanjot Singh @drquark:kde.org
- Aakarsh MJ @aakarshmj:matrix.org
- Pradyot Ranjan (Video) @pradyotranjan:gitter.im
Issues Working on
Weekly Progress
Week 1:
- Explored KECoLab Project's codebase, and it's working through a demo.
- Studied KECoLab's Handbook and existing documentation.
- Set up a GitLab Wiki in the forked repository.
- Discussed GitLab Wiki's Merge Request (MR) feature.