NEW: Development documentation #15
Conversation
| @@ -1,2 +1,10 @@ | |||
| # EmbeddedChat | |||
| An easy to use full-stack component (ReactJS + backend behaviors) embedding Rocket.Chat into your webapp | |||
|
|
|||
| ## Development | |||
There was a problem hiding this comment.
Please describe what this is. Show a screen capture of how it looks like.
How will the potential contributor be able to test his code?
How can this component be embedded into a web page or react app as it exists right now?
|
Please submit the README.md update ALONE as a separate PR (without any code). I'll be able to test and review the instructions. Hopefully helping out Rohan a bit on this. |
|
@Sing-Li sure, I will update the whole README in this PR and when I'm done I'll tag you! |
|
@Sing-Li as of now, can you please give a quick review of the documentation. I've added all the necessary steps that should be taken to set the component up. The component hasn't been deployed yet, we can release it after the Auth and API get complete. After that |
|
@sidmohanty11 when will the "auth and api" get completed? We need this to have good developer experience before the mid-term (in the next week or two). How can new devs:
WITHOUT waiting for that work to complete? |
|
|
||
| *EmbeddedChat is a full-stack React component node module of the RocketChat application that is fully configurable, extensible, and flexible for use. It is tightly bound with the RocketChat server using Rocket.Chat nodejs SDK and its UI using RocketChat's Fuselage Design System.* | ||
|
|
||
|  |
There was a problem hiding this comment.
Not a good screen capture for this purpose.
It looks no different than a non-embedded chat window. Bringing up the bigger question of -- what is this project for?
Your screen capture should clearly show (ALL) the added values that this component bring to our community. This picture is your THOUSAND WORDS.
There was a problem hiding this comment.
True. 100% agreed. Let me search a bit around for mockups that I can use. I will send some samples in the channel.
sidmohanty11
force-pushed
the
documentation
branch
from
fa31531
to
7c7cda8
Compare
Development documentation