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.

Sign up for GitHub

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

Jump to bottom

Update /docs examples and guides #699

Merged
merged 3 commits into from
Mar 1, 2019
Merged

Update /docs examples and guides #699

merged 3 commits into from
Mar 1, 2019

Conversation

pinheadmz
Copy link
Member

Starting this PR off by adding @tynes guide from #688 and my updates in #667

We can consolidate discussion about the /docs directory here and I'll close the other two PRs. The goal is to update everything in this directory.

@codecov-io

This comment has been minimized.

Sign in to view
This was referenced Feb 12, 2019
Closed
Closed
@braydonf braydonf added the docs UI isn't clear or documented guidance needed label Feb 12, 2019
@pinheadmz
Copy link
Member Author

This PR now depends on #700 since it explicitly calls console.log(block), which throws an assertion error in inspect() as it tries to get the witness commitment hash as a string instead of a buffer...

@pinheadmz
Copy link
Member Author

This PR now also depends on #704 for the miner-configs example, which will currently exit before a nonce is returned from the worker threads.

@pinheadmz pinheadmz changed the title 🚫WIP: Update /docs examples and guides Update /docs examples and guides Feb 21, 2019
@pinheadmz
Copy link
Member Author

This PR now also relies on #707 in that it assumes bclient is installed globally if bcoin is installed globally, so users can access the CLI.

braydonf
braydonf reviewed Feb 22, 2019
View reviewed changes
braydonf
braydonf reviewed Feb 22, 2019
View reviewed changes
braydonf
braydonf reviewed Feb 22, 2019
View reviewed changes
braydonf
braydonf reviewed Feb 22, 2019
View reviewed changes
braydonf
braydonf reviewed Feb 22, 2019
View reviewed changes
braydonf
braydonf reviewed Feb 22, 2019
View reviewed changes
braydonf
braydonf reviewed Feb 22, 2019
View reviewed changes
@pinheadmz pinheadmz mentioned this pull request Feb 22, 2019
Open
1 task
@pinheadmz
Copy link
Member Author

@braydonf feedback addressed

braydonf
braydonf reviewed Feb 22, 2019
View reviewed changes
braydonf
braydonf reviewed Feb 26, 2019
View reviewed changes
@pinheadmz
Copy link
Member Author

nits addressed, squashed and pushed.

@pinheadmz
Copy link
Member Author

Last commit fixes the miner-config.js example by adding a timeout to keep the process open long enough to get an answer from the workers, and explained in the comments.

See #704 for more details.

braydonf added a commit to braydonf/bcoin that referenced this pull request Mar 1, 2019
@braydonf
Merge pull request bcoin-org#699 pinheadmz/docsupdate
c64ccf2 
Update /docs examples and guides
@braydonf braydonf merged commit 7e8c575 into bcoin-org:master Mar 1, 2019
@braydonf braydonf mentioned this pull request Mar 1, 2019
Closed
@pinheadmz pinheadmz mentioned this pull request May 2, 2019
Merged
@braydonf braydonf added this to the 2.0.0 milestone Jan 6, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@braydonf braydonf braydonf approved these changes

@nodech nodech nodech left review comments

@tynes tynes tynes left review comments

Assignees
No one assigned
Labels
docs UI isn't clear or documented guidance needed
Projects
None yet
Milestone
v2.0.0
Development

Successfully merging this pull request may close these issues.
5 participants
@pinheadmz @codecov-io @braydonf @nodech @tynes