Closed thomas-nicolai-frequenz closed 10 months ago
Before going with a particular format, I strongly recommend trying out how it is rendered doing:
pip install -e .[dev-mkdocs]
mkdocs serve
Remember Markdown is used, so probably things like Key Features:
are better as headings (like ## Key Features
).
What's needed?
In order to give the service more context whats it about I'd suggest to rename the service from
DispatchService
toMicrogridDispatchService
orMicrogridDispatchService
.Proposed solution
Please rename service and extend the documentation above. Here is a draft:
Also renaming the service and rpc methods is suggested:
Use cases
No response
Alternatives and workarounds
No response
Additional context
No response