From c7a7d9b48a650b8dba0ee02d2196e288c911de06 Mon Sep 17 00:00:00 2001 From: yukang Date: Fri, 24 Jan 2025 15:53:46 +0800 Subject: [PATCH] add help link in document --- Makefile | 2 +- README.md | 2 ++ src/rpc/README.md | 2 ++ 3 files changed, 5 insertions(+), 1 deletion(-) diff --git a/Makefile b/Makefile index 2613c462..c850e412 100644 --- a/Makefile +++ b/Makefile @@ -55,7 +55,7 @@ coverage: coverage-run-unittests coverage-collect-data coverage-generate-report .PHONY: gen-rpc-doc gen-rpc-doc: - $(if $(shell command -v fiber-rpc-gen),,cargo install fiber-rpc-gen --version 0.1.6 --force) + $(if $(shell command -v fiber-rpc-gen),,cargo install fiber-rpc-gen --version 0.1.8 --force) fiber-rpc-gen ./src/ if grep -q "TODO: add desc" ./src/rpc/README.md; then \ echo "Warning: There are 'TODO: add desc' in src/rpc/README.md, please add documentation comments to resolve them"; \ diff --git a/README.md b/README.md index 253a9563..d2f61cbe 100644 --- a/README.md +++ b/README.md @@ -80,6 +80,8 @@ fnn-migrate -p /folder-to/my-fnn/fiber/store * [P2P Message Protocol](./docs/specs/p2p-message.md) * [Invoice Protocol](./docs/specs/payment-invoice.md) +**We are in a actively developing stage, don't hesitate to [report issues](https://github.com/nervosnetwork/fiber/issues) or ask for help in the [channel of the Nervos dev community](https://discord.gg/c5gntbFd).** + ## Testnet deployment information * TODO: Add testnet deployed nodes information * diff --git a/src/rpc/README.md b/src/rpc/README.md index 4fd8d47f..d3ce65fd 100644 --- a/src/rpc/README.md +++ b/src/rpc/README.md @@ -7,6 +7,8 @@ Allowing arbitrary machines to access the JSON-RPC port (using the `rpc.listenin You may refer to the e2e test cases in the `tests/bruno/e2e` directory for examples of how to use the RPC. +**We are in a actively developing stage, don't hesitate to [report issues](https://github.com/nervosnetwork/fiber/issues) or ask for help in the [channel of the Nervos dev community](https://discord.gg/c5gntbFd).** + * [RPC Methods](#rpc-methods)