Revision as of 15:53, 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.

Week 2:

Created an outline for the entire technical documentation for KECoLab.
Written usage scenario script for the users.
Experimented with various methods of creating a MR for GitLab Wiki.
Discussed with team members about the default setting of GitLab Wiki section.

@@ Line 27: / Line 27: @@
 * Set up a GitLab Wiki in the forked repository.
 * Discussed GitLab Wiki's Merge Request (MR) feature.
+<h4>Week 2: </h4>
+* Created an outline for the entire technical documentation for KECoLab.
+* Written usage scenario script for the users.
+* Experimented with various methods of creating a MR for GitLab Wiki.
+* Discussed with team members about the default setting of GitLab Wiki section.