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

bootstrap-chat docs update #275

Merged
merged 11 commits into from
Oct 28, 2020
Merged

bootstrap-chat docs update #275

merged 11 commits into from
Oct 28, 2020

Conversation

pringshia
Copy link
Contributor

@pringshia pringshia commented Oct 7, 2020

Finished up the bootstrap-chat docs.

Have one minor note below regarding the IDLE state for INPUT_MODE which doesn't seem to be ever set anywhere. Should we remove? Or does this represent a future feature we will be adding regarding idleness/timeouts?

@facebook-github-bot facebook-github-bot added the CLA Signed This label is managed by the Facebook bot. Authors need to sign the CLA before a PR can be reviewed. label Oct 7, 2020
@codecov-io
Copy link

codecov-io commented Oct 7, 2020

Codecov Report

Merging #275 into master will increase coverage by 0.01%.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##           master     #275      +/-   ##
==========================================
+ Coverage   66.57%   66.59%   +0.01%     
==========================================
  Files          74       74              
  Lines        6627     6627              
==========================================
+ Hits         4412     4413       +1     
+ Misses       2215     2214       -1     
Impacted Files Coverage Δ
mephisto/server/channels/websocket_channel.py 82.55% <0.00%> (+1.16%) ⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 2c2636e...cf44a4b. Read the comment docs.

packages/bootstrap-chat/README.md Outdated Show resolved Hide resolved
packages/bootstrap-chat/README.md Show resolved Hide resolved
Copy link
Contributor Author

@pringshia pringshia left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

some WIP comments & TODOs

@pringshia pringshia changed the title [WIP] bootstrap-chat docs update bootstrap-chat docs update Oct 22, 2020
Copy link
Contributor

@JackUrb JackUrb left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great docs - really solid overview for how bootstrap-chat is intended to be used, and important documentation of the heaviest-lifting parts of the package.

Reading through though, it may be also good to document some of the more-likely-to-be-used underlying components, such as ChatMessage, perhaps in a bootstrap-chat/src/README.md.

packages/bootstrap-chat/README.md Outdated Show resolved Hide resolved
packages/bootstrap-chat/README.md Outdated Show resolved Hide resolved
@pringshia pringshia merged commit d0eac99 into master Oct 28, 2020
@pringshia pringshia deleted the bootstrap-chat-docs branch October 28, 2020 15:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CLA Signed This label is managed by the Facebook bot. Authors need to sign the CLA before a PR can be reviewed.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants