Join GitHub today
GitHub is home to over 40 million developers working together to host and review code, manage projects, and build software together.
Sign upGo kosu/rpc docs #176
Go kosu/rpc docs #176
Conversation
|
It is ideal to output the docs for each package within the monorepo to a Can we move the generated markdown to |
This comment has been minimized.
This comment has been minimized.
|
Looks like you may have already moved the doc, so my comment above may no longer be relevant! looks like there are still some linting checks that are failing |
This comment has been minimized.
This comment has been minimized.
|
should we keep all docs under |
This comment has been minimized.
This comment has been minimized.
|
hmmm... unless there is reason to do is that ok? |
This comment has been minimized.
This comment has been minimized.
|
it also seems like the full go-kosu tests never ran on #174, so the build looks like it passed when really the go-kosu tests are failing (meaning the master branch is now broken) Nick and I are examining and seeing if we can change how the |
gchaincl commentedJul 23, 2019
Overview
Updates the code comments and add requires support to generate rpc documentation
ATM, doc generation is very rudimentary:
go to
./rpc/doctooland run:go run main.go ../ > ../../../kosu-docs/docs/kosu-rpc/methods.md