search

Concordium / concordium-node

The main concordium node implementation.
GNU Affero General Public License v3.0
45 stars 22 forks source link

GRPC changes: Documentation #987

Closed MilkywayPirate closed 5 months ago

MilkywayPirate commented 1 year ago

For release 6.1.x new commands exposed in the high level API of the concordium client must be described in our developer documentation.

The raw API itself should also have it documentation rebuilt after release.

abizjak commented 1 year ago

The raw commands are not really covered in developer documentation. I don't think we need to start that.

We have the generated (and linked to from developer documentation) GRPC documentation which should document these APIs.

The new high-level commands should be described in the relevant developer documentation section though.

MilkywayPirate commented 1 year ago

@td202 and @dg-concordium will you take care of the high level commands introduced in the client? As I recall then it is only GetBakerEarliestWinTime that is exposed in the high level API?

MilkywayPirate commented 1 year ago

The raw commands are not really covered in developer documentation. I don't think we need to start that.

We have the generated (and linked to from developer documentation) GRPC documentation which should document these APIs.

The new high-level commands should be described in the relevant developer documentation section though.

Changed description of task.

abizjak commented 12 months ago

Is this still relevant, does something need to be done, or should this be closed?

dg-concordium commented 11 months ago

I think this was done, wasn't it?

MilkywayPirate commented 11 months ago

This pr https://github.com/Concordium/concordium.github.io/pull/912 solves this issue.