Skip to content

7 doc/nld proofread - #19

Merged
roda82 merged 135 commits into
powerapi-ng:masterfrom
Inkedstinct:7_doc/nld_proofread
Jun 4, 2026
Merged

7 doc/nld proofread#19
roda82 merged 135 commits into
powerapi-ng:masterfrom
Inkedstinct:7_doc/nld_proofread

Conversation

@roda82

@roda82 roda82 commented Jan 8, 2025

Copy link
Copy Markdown
Contributor

Refactoring:

  • Sources/Destination are now only referenced as input/output for each component, not as PowerAPI abstraction
  • Getting-Started:
    • Add instructions to create necessary elements to monitor
    • Add archive and walkthrough for a "one liner" possible usage
  • Overview
    • Clarify component types in PowerAPI framework
  • HWPC-Sensor:
    • Add illustration of basic concept
    • Improve examples usage by external users
    • Add examples to use CSV output
  • SmartWatts:
    • Improve examples usage by external users
    • Add examples to use CSV input
  • Reports:
    • Add JSON schema
    • Introduce idea of "Data contract" for interfacing Sensors & Formulas

== Local dev/review instructions ==
I completed the README.md with some commands to get working versions served locally

Nathan Leblond and others added 30 commits October 4, 2024 16:58
Add a docker compose file and the beginning of a python script to have an easy one-liner to use in the documentation
Add a docker compose gestion in the python file with a bash script
pylint and flake8 OK + remove formula verbose
The first version of the getting started archive is ready to be used and tested.
Adapt the getting started documentation to better match the archive
KellianL and others added 26 commits October 29, 2025 11:32
@roda82 roda82 self-assigned this Jun 4, 2026
@roda82 roda82 closed this Jun 4, 2026
@roda82 roda82 reopened this Jun 4, 2026
@roda82
roda82 merged commit fcb154c into powerapi-ng:master Jun 4, 2026
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.

4 participants