Add overview and description of the Frequenz Microgrid API #142
Conversation
github-actions
bot
added
part:docs
tiyash-basu-frequenz
force-pushed
the
docs
branch
from
96cb421 to
0617541
Compare
tiyash-basu-frequenz
force-pushed
the
docs
branch
from
0617541 to
641bbdf
Compare
tiyash-basu-frequenz
added
the
cmd:skip-release-notes
tiyash-basu-frequenz
force-pushed
the
docs
branch
from
f7e792b to
c9c4739
Compare
tiyash-basu-frequenz
force-pushed
the
docs
branch
2 times, most recently
from
1066b56 to
2b65ed7
Compare
Fixed |
tiyash-basu-frequenz
force-pushed
the
docs
branch
from
2b65ed7 to
2a8d0e6
Compare
tiyash-basu-frequenz
force-pushed
the
docs
branch
from
2a8d0e6 to
9437d31
Compare
tiyash-basu-frequenz
force-pushed
the
docs
branch
from
9437d31 to
574621f
Compare
|
Rebased on latest upstream head. |
tiyash-basu-frequenz
dismissed stale reviews from stefan-brus-frequenz and thomas-nicolai-frequenz
via
ce687da
tiyash-basu-frequenz
force-pushed
the
docs
branch
from
ce687da to
b20437f
Compare
README.md
Outdated
|
|
||
| - **Component Graphs:** The API provides a way to list connections between | ||
| components. Connections are represented as pairs of component IDs, describing | ||
| an abstract flow of current according to the passive sign convention. The |
There was a problem hiding this comment.
I find this wording a bit confusing. I suggest to mention that this graph is directed. Otherwise the point about the passive sign convention doesn't make sense. Furthermore I'd suggest to write ... "an abstracted flow of current ..." because I understand that there is an "abstract flow". Also we are following the passive the passive sign convention.
There was a problem hiding this comment.
The lines you are referring to do not talk about graphs at all. How this turns into a graph is explained in the next line.
There was a problem hiding this comment.
I added the term directed in the next line where it mentions graphs.
There was a problem hiding this comment.
Furthermore I'd suggest to write ... "an abstracted flow of current ..." because I understand that there is an "abstract flow". Also we are following the passive the passive sign convention.
Difficult to follow you here. I updated the text again. Note that we want to keep it high-level and not add too much tech detail here.
tiyash-basu-frequenz
force-pushed
the
docs
branch
from
b20437f to
ab5b3f7
Compare
Signed-off-by: Tiyash Basu <[email protected]>
Signed-off-by: Tiyash Basu <[email protected]>
Signed-off-by: Tiyash Basu <[email protected]>
Signed-off-by: Tiyash Basu <[email protected]>
tiyash-basu-frequenz
force-pushed
the
docs
branch
from
ab5b3f7 to
4614081
Compare
No description provided.