[bisq-network/compensation] For Cycle 34 (Issue #1033)

[Stan]

> @ghubstan As `Generate API Reference markdown, implement API cli/java/python examples` is quite a big contribution, could you break it down a bit, so it is easier to evaluate by all contributors? Thanks!

I break it down in today's changes to the project's and subprojects' READMEs, primarily in the [top-level project's README](https://github.com/ghubstan/bisq-api-reference/blob/main/README.md), and the [doc-generator subproject README](https://github.com/ghubstan/bisq-api-reference/blob/main/reference-doc-builder/README.md).

## In Summary:  What is the bisq-api-reference repo?

The repo's main purpose is to generate the Markdown text for the [API Reference](https://bisq-network.github.io/slate). It also provides a Java and Python workarea for running API client example code, and developing new Java and Python clients and bots.

It contains four subprojects:

1. [reference-doc-builder](https://github.com/ghubstan/bisq-api-reference/tree/main/reference-doc-builder) -- The Java application that produces the [API Reference](https://bisq-network.github.io/slate) content, from commented Bisq protobuf definition files.
2. [cli-examples](https://github.com/ghubstan/bisq-api-reference/tree/main/cli-examples) -- A folder of bash scripts demonstrating how to run API CLI commands. Each script is named for the RPC method call being demonstrated.
3. [java-examples](https://github.com/ghubstan/bisq-api-reference/tree/main/java-examples) -- A Java project demonstrating how to call the API from Java gRPC clients. Each class in the [bisq.rpccalls](https://github.com/ghubstan/bisq-api-reference/tree/main/java-examples/src/main/java/bisq/rpccalls) package is named for the RPC method call being demonstrated.
4. [python-examples](https://github.com/ghubstan/bisq-api-reference/tree/main/python-examples) -- A Python3 project demonstrating how to call the API from Python3 gRPC clients. Each class in the  [bisq.rpccalls](https://github.com/ghubstan/bisq-api-reference/tree/main/python-examples/bisq/rpccalls) package is named for the RPC method call being demonstrated. There are also some simple bot examples in the [bisq.bots](https://github.com/ghubstan/bisq-api-reference/tree/main/python-examples/bisq/bots) package.

The RPC method examples are also displayed in the [API Reference](https://bisq-network.github.io/slate). While navigating the RPC method links in the reference's table of contents on the left side of the page, they appear in the dark, right side of the page. There is also a copy-to-clipboard icon at the top right of each example.

-- 
Reply to this email directly or view it on GitHub:
https://github.com/bisq-network/compensation/issues/1033#issuecomment-1080611919
You are receiving this because you are subscribed to this thread.

Message ID: <bisq-network/compensation/issues/1033/1080611919 at github.com>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.bisq.network/pipermail/bisq-github/attachments/20220328/a2306236/attachment-0001.htm>