Skip to content

Commit 38ad27e

Browse files
committed
[FAB-8176] API Reference doc
Moved the API Reference doc section from Getting Started to the Contributions Welcome! section. Also fixed the bad GO link for the ChaincodeShimInterface APIs Change-Id: I3f630bdda8dc4d6a31511b09aa19f32dfe5fede0 Signed-off-by: pama-ibm <pama@ibm.com>
1 parent bda6ad9 commit 38ad27e

File tree

3 files changed

+8
-10
lines changed

3 files changed

+8
-10
lines changed

docs/source/Style-guides/go-style.rst

+7-1
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,13 @@ code and fix all errors and warnings: -
1212
vet <https://golang.org/cmd/vet/>`__ -
1313
`goimports <https://godoc.org/golang.org/x/tools/cmd/goimports>`__
1414

15+
API Documentation
16+
^^^^^^^^^^^^^^^^^
17+
18+
The API documentation for Hyperledger Fabric's Golang APIs is available
19+
in `GoDoc <https://godoc.org/github.com/hyperledger/fabric>`_.
20+
21+
1522
Generating gRPC code
1623
---------------------
1724

@@ -36,4 +43,3 @@ packages in this folder instead of the GOPATH when the ``go install`` or
3643

3744
.. Licensed under Creative Commons Attribution 4.0 International License
3845
https://creativecommons.org/licenses/by/4.0/
39-

docs/source/chaincode4ade.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ application state. The ``Invoke`` method is called in response to receiving an
3939

4040
The other interface in the chaincode "shim" APIs is the ``ChaincodeStubInterface``:
4141

42-
- `Go <https://godoc.org/github.com/hyperledger/fabric/core/chaincode/shim#ChaincodeStub>`__
42+
- `Go <https://godoc.org/github.com/hyperledger/fabric/core/chaincode/shim#ChaincodeStubInterface>`__
4343
- `node.js <https://fabric-shim.github.io/ChaincodeStub.html>`__
4444

4545
which is used to access and modify the ledger, and to make invocations between

docs/source/getting_started.rst

-8
Original file line numberDiff line numberDiff line change
@@ -23,14 +23,6 @@ binaries, we provide a script that will :doc:`install` to your system. We think
2323
that you'll find the sample applications installed useful to learn more about
2424
the capabilities and operations of Hyperledger Fabric.
2525

26-
API Documentation
27-
^^^^^^^^^^^^^^^^^
28-
29-
The API documentation for Hyperledger Fabric's Golang APIs can be found on
30-
the godoc site for `Fabric <https://godoc.org/github.com/hyperledger/fabric>`_.
31-
If you plan on doing any development using these APIs, you may want to
32-
bookmark those links now.
33-
3426
Hyperledger Fabric SDKs
3527
^^^^^^^^^^^^^^^^^^^^^^^
3628

0 commit comments

Comments
 (0)