Skip to content

Commit

Permalink
Merge pull request #500 from chenyukang/add-help-link
Browse files Browse the repository at this point in the history
chore: add help link in document
  • Loading branch information
quake authored Jan 27, 2025
2 parents 2f12f40 + c7a7d9b commit 07125f8
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 1 deletion.
2 changes: 1 addition & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -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"; \
Expand Down
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 *
Expand Down
2 changes: 2 additions & 0 deletions src/rpc/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).**

<!--**NOTE:** the content below is generated by gen_doc -->

* [RPC Methods](#rpc-methods)
Expand Down

0 comments on commit 07125f8

Please sign in to comment.