Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Go kosu/rpc docs #176

Merged
merged 15 commits into from Aug 1, 2019
Merged

Go kosu/rpc docs #176

merged 15 commits into from Aug 1, 2019

Conversation

@gchaincl
Copy link
Contributor

gchaincl commented Jul 23, 2019

Overview

Updates the code comments and add requires support to generate rpc documentation

ATM, doc generation is very rudimentary:
go to ./rpc/doctool and run:

go run main.go ../ > ../../../kosu-docs/docs/kosu-rpc/methods.md
@gchaincl gchaincl requested a review from hrharder Jul 23, 2019
@gchaincl gchaincl force-pushed the go-kosu/rpc-docs branch from e0a0a5c to fc476b2 Jul 23, 2019
Copy link
Member

hrharder left a comment

It is ideal to output the docs for each package within the monorepo to a PACKAGE-NAME/docs folder, so then the kosu-docs package build process can be automated to pull in docs from each package.

Can we move the generated markdown to go-kosu/docs? Other than that, everything looks good!

@hrharder

This comment has been minimized.

Copy link
Member

hrharder commented Jul 23, 2019

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 🤷‍♂

@gchaincl

This comment has been minimized.

Copy link
Contributor Author

gchaincl commented Jul 23, 2019

should we keep all docs under go-kosu/docs or go-kosu/<module>/docs is better?

@gchaincl gchaincl force-pushed the go-kosu/rpc-docs branch from 6981994 to fc476b2 Jul 23, 2019
@hrharder

This comment has been minimized.

Copy link
Member

hrharder commented Jul 23, 2019

hmmm... unless there is reason to do go-kosu/<module>/docs I think go-kosu/docs/<module>/files would be better, as it lines up with how it works in other repos.

is that ok?

@hrharder

This comment has been minimized.

Copy link
Member

hrharder commented Jul 23, 2019

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 changeset plugin works

@gchaincl gchaincl force-pushed the go-kosu/rpc-docs branch from 965e501 to be95b90 Jul 31, 2019
gchaincl and others added 13 commits Jul 23, 2019
@hrharder hrharder self-requested a review Aug 1, 2019
hrharder added 2 commits Aug 1, 2019
@gchaincl gchaincl merged commit e326fbf into master Aug 1, 2019
1 check passed
1 check passed
continuous-integration/drone/pr Build is passing
Details
@gchaincl gchaincl deleted the go-kosu/rpc-docs branch Aug 1, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked issues

Successfully merging this pull request may close these issues.

None yet

2 participants
You can’t perform that action at this time.