fabric icon indicating copy to clipboard operation
fabric copied to clipboard

Refactor Developing Applications documentation

Open denyeart opened this issue 3 years ago • 7 comments

"Developing Applications" doc has gotten somewhat outdated and is based on the Commercial Paper chaincode that many people don't understand. It should be overhauled and potentially based on a simpler chaincode that new developers can more easily understand.

Additionally it needs to be refactored for the new embedded peer Gateway.

denyeart avatar Oct 14 '21 10:10 denyeart

Can I work on this issue? @denyeart

DARK-art108 avatar Nov 25 '21 17:11 DARK-art108

@DARK-art108 Yes, please coordinate with @bestbeforetoday (aka Mark Lewis, aka bestbeforetoday) on the proposed approach. Mark is the application SDK lead and should be involved in Developing Applications changes.

denyeart avatar Nov 29 '21 04:11 denyeart

Offline signing seems like a significant feature or use case for the Fabric Gateway SDKs. I was unable to find it in the documentation anywhere except in the code and tests. Would this be something that should get a section?

jonmchan avatar Jan 04 '22 17:01 jonmchan

Offline signing seems like a significant feature or use case for the Fabric Gateway SDKs. I was unable to find it in the documentation anywhere except in the code and tests. Would this be something that should get a section?

There is some description and code examples in the API documentation for the Contract in each of the client languages:

  • Go: https://pkg.go.dev/github.com/hyperledger/fabric-gateway/pkg/client#Contract
  • Node: https://hyperledger.github.io/fabric-gateway/main/api/node/interfaces/Contract.html
  • Java: https://hyperledger.github.io/fabric-gateway/main/api/java/org/hyperledger/fabric/client/Contract.html

Any additional documentation giving a language agnostic overview of the client API structure and usage patterns (perhaps a reworked developing applications section) should cover off-line signing too.

bestbeforetoday avatar Jan 04 '22 19:01 bestbeforetoday

Developing Applications doc has been removed. Intent now is to add some of the main concepts to the Key Concepts and Tutorial topics.

denyeart avatar May 16 '22 11:05 denyeart